Articles in this section

Create your first integration

Tom Santiago
Updated

An integration contains one or more flows, APIs, or tools set up to achieve your needs for manipulating and moving data between systems. An integration can refer to a single flow or API or a set, grouped in a folder. The container that organizes these flows or APIs is an integration, and it is represented by either a rectangular tile in the tile view or a specific row in the list view of the Home page. You can group flows into integrations however you like.

See also key integration concepts and integration-related terms.

Create an integration

Note

You must have Manage all permissions to create an integration.

See Manage account and integration permissions.

You can create an integration to group related flows and APIs in the same location. However, integrator.io stores any flows and APIs you create from the Resources menu in Standalone Flows. Once you create additional integrations, you can move any flow or API stored in Standalone Flows to any integration.

Use the following steps to create an integration:

  1. On the Home page at the top right, click Create and select Integration.

    Create integration.png

  2. Give your integration a name and an optional description.

  3. Click Save.

    Your first integration is now created. You can view the integration on the Home page.

    To create flows or APIs in your integration, see Create custom flows and Create and manage APIs using API builder.

View your integration

You can view your integration either as a tile in the default tile view or as a row in the list view. These views are only available on the Home page.

In the tile view, you can drag and drop an integration using the dots icon in the upper-left corner of the tile. The drag-and-drop feature is useful when you have many integrations and want to move them around based on your priorities.

platform-options-tile-view.png

In the list view, you can pin and unpin an integration. The pin/unpin feature is useful when you have many integrations but want to view select priority integrations at the top of the list. You can also view the applications that are a part of the integration folder.

platform-options-list-view.png

From the Home page, in both views, you can perform actions like cloning, downloading, or deleting the integration.

Note

Cloning or downloading an integration that contains APIs is not yet supported, but will be introduced in an upcoming release as part of Integration Lifecycle Management (ILM) support for APIs.

Monitor your integration

Note

The options available and actions you can take will vary based on your role and permissions. See Manage account and integration permissions.

integrationTile.png

  1. Settings: This JSON settings field is exposed on many of the core resource types (integrations, flows, exports, imports, connections, etc.). You can use this field to parameterize the logic within your resource to incorporate hooks, filters, or handlebars. The settings fields stored on linked/related resources are also accessible at runtime. For example, the settings field defined at the integration tile level will be accessible to all flows running within the same integration tile. It is recommended that you create a custom form to expose and manage your settings fields, so that less technical users do not need to work with raw JSON.

    Note

    JSON settings are not available for APIs.

  2. Flows: This tab lists all the flows in the integration tile. You can also create new flows for the integration from this tab.

  3. APIs: This tab lists all the APIs in the integration tile. You can also create new APIs for the integration from this tab.

  4. Tools: This tab lists all the tools in the integration tile. You can also create new tools for the integration from this tab.

  5. Dashboard: This tab (default) allows you to monitor all flows. You can correct or retry any errors for any of the flows in the integration from this tab.

  6. Connections: This tab lists all the connections in your integration tile.

  7. Notifications: This tab allows you to configure and modify email notifications.

  8. Audit Log: This tab allows you to view and monitor all activity in your integration tile.

  9. Analytics: This tab shows graphs of total stats (success, error, ignore count) produced in the flow steps, helping you to see trends and identify performance issues or unexpected spikes in integration activity.

  10. Users: This tab allows you to view and manage all users who have access to the integration.

  11. Admin: This tab allows you to view and edit the Name, Description, and Readme for the integration tile.

  12. Aliases: This tab lists all aliases that have been defined for this integration's flows, connections, imports, and exports.

    Note

    Aliases are not available for APIs.

  13. Revisions: This tab displays every change or revision made to the integration as a result of a snapshot, pull, or revert.

  14. Clone integration: This button allows you to clone all components in the integration. This is useful if you plan on making a lot of modifications, but do not want to break anything that currently works while testing changes.

    Note

    Cloning or downloading an integration that contains APIs is not yet supported, but will be introduced in an upcoming release as part of Integration Lifecycle Management (ILM) support for APIs.

  15. Delete integration: This button allows you to delete the integration. You can't delete the Standalone Flows integration.

Check out our community forum for more info on integrator.io and Flow Builder. You can ask questions and post tips.