Skip to main content

Integrations Overview

What is an Integration?#

An integration is a series of steps that execute one after another in series. Each step runs an action - a small bit of code designed to perform a specific task. Actions can be things like "HTTP - GET" to fetch the contents of a webpage from the internet, or "Amazon S3 - Put Object" to save a file to Amazon S3. You can use a combination of actions from common built-in components and your own custom components to build an integration.

An integration is started when its trigger fires. Triggers can either follow a schedule, or can be invoked via a webhook URL.

Integrations should be developed to be configuration-driven, so they can be deployed to multiple customers with potentially different configurations. That is accomplished by leveraging config variables, and have configuring steps to reference those variables.

When an integration is completed, it can be published, and then instances of the integration can be deployed to one or more customers with customer-specific config variables.

We recommend that you follow our Getting Started tutorial to first acquaint yourself with integration development.

How to Create Your First Integration

Creating a New Integration#

To create a new integration in the web app, click Integrations from the left-side menu, and then click the + Integration button in the upper-right. You will find yourself in a new integration designer screen. Click the name and description at the top left to give your new integration an appropriate name and description.

For more information: Building Integrations, Testing Integrations

Listing and Searching Integrations#

To view all of the integrations your organization has created, click the Integrations link on the left-hand sidebar.

You can search for specific integrations by name by typing a part of the name in the upper search bar, or you can search by description by clicking the Filter button to the right of the search bar.

Publishing An Integration#

By publishing an integration, you mark it ready for deployment to customers.

To publish an integration, first open the VERSION HISTORY tab on the left side of the page. If you have unpublished changes you'll see an Unpublished Draft listed among the integration's versions. Type a note about the changes you made to the integration, and then click SAVE & PUBLISH to release a new version of your integration:

Integration versions can be marked Available or Unavailable by toggling the blue toggles to the right of integration versions. Marking an integration version Unavailable prevents that version from being deployed as an instance to a customer.

Deploying An Integration#

Once an integration has been published, an instance of the integration can be configured and deployed to a customer. See the instances article for information on deploying instances of integrations.

View Deployed Instances#

To view all instances of an integration that have been deployed, click the Instances tab from the integration designer screen. This screen will display customers to which this integration has been deployed.

The version of this integration that is deployed to each customer is shown within this drawer.

Forking An Integration#

How to Make a Copy of an Integration

Sometimes you will want to make a copy of an integration and modify the copy. This is called forking an integration.

From the integration designer, click the

icon on the bottom left of the page. Then, click Fork Integrations. Give your forked integration a new name and description and then click ADD.

Deleting an Integration#

Deleting an integration will delete all instances of that integration

Use caution when deleting an integration. Deletion of an integration also deletes all deployed instances of that integration.

From the integration designer, click the

icon on the bottom left of the page. Click the Delete Integration button on the bottom of the page and confirm by clicking REMOVE INTEGRATION.

Integration Attachments#

Your team can save and share integration-related documents alongside an integration by clicking on the Attachments tab from the integration designer page.