PlatformIntegration GuidesGeneral Integration Setup Guide

General Integration Setup Guide

To set up a new integration, go to Data PipelinesIntegrations and click Create Integration:


Create Integration

Search for the name of your integration. In the example below, we searched for Microsoft Entra ID (Azure AD):


Search for integration

On the next screen, enter the Integration Name to identify the integration by later (if unsure, use the name of the Integration).


Integration Name

If applicable, fill out the Yaml specification. The link to the integration documentation will have more information about the format required.

Most of the integrations will require some form of authentication. We recommend using the Secrets section below to make the values available to the sync as environment variables. Reference the variables using placeholders such as ${my_secret_value} in the YAML configuration.


Secrets

When you’re ready to test, click Test Connection. If there are any errors during the test, they will be displayed on the page.

Next Steps

With your integration created, you can now proceed to use it in a new sync. This will give you the opportunity to specify when your sync should be run, and to which destination databases.