Creating an integration with a third-party service

Step 0: Integration Source (This step is required if you have not already configured an integration source)

To create an integration, you first need a source to connect to. 

Click the Integration Source Configurations tab located in the External Connections option of the Configuration menu.

Click Create a new Integration Source

In the new page displayed, choose an integration source from the drop-down list and enter a name for this new configuration source.

You need authorization from the third-party service to communicate. Click the See third-party service authorizations button.

In the pop-up window, select the authorization from the list. 

If it has not been previously created, refer here for creating authorization for an external service:

Click the Save button.

Next, you must choose the type of data to transfer. In the Data transfer section, click the Add button. In the drop-down list displayed, select the type of data to transfer and click the Add button.

The integration configuration will be displayed, but by default it will be inactive. To enable it, you must first make the field assignment.

Click on the gear icon and then on the Mapping option.

In the pop-up, you must first choose the primary key from the third-party solution and assign it to a field in the project. Select the Primary key check box. 

Then continue with the assignment of your fields then click the Add button.

Go back to the gear icon menu and click on the Activate option. You can confirm that the status has changed to Active.

You have completed the configuration of an integration source!

Step 1: Create the integration

Click on the Create an integration button. 


In the drop-down list, choose the integration configuration (See step 0).

Step 2: Choose the type of updates

After selecting an integration source, a content block will appear asking you what type of update you would like to receive.

The different types of data will be displayed. Click on the name of the ones you are interested in to bring up a list showing the possible types of updates. Check the box of the ones you want.

Once your selection is complete, click on the Save button.


Step 3: Sign up for email alerts

You can add an email address to which an alert will be sent if the integration has been disabled due to a large number of errors.

Click on Add in the Email alert section and then choose your email in the drop-down list. 

Once the email has been added, click on the Save button.

Step 4: Activate your third-party service integration

Once you have completed the above steps, all that remains is to activate the integration.

At the bottom of the page, click the Activate button.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.