How to Set up Connectors Programmatically

Use Case

You want to programmatically create connectors at scale without using the Fivetran dashboard.

The following are the most common use cases:

• Powered by Fivetran
• Enterprise: Different Business Units

Recommendations

Our REST API is a crucial aspect of limiting manual work for setting up dozens or hundreds of connectors.

Once you know the destination you are using and have connected it to a Fivetran group, you can begin creating connectors using Connector Management.

Process

1. Find the source Connector Config that you want to sync.

2. In the request body of the Create a Connector endpoint, replace the config field with the specific connector’s config from Step 1.

3. Change the payload parameters in the request body to the service and group_id.

4. Send a POST request to the Create a Connector endpoint.

5. Validate that the new connector has been created successfully. Check that you've received the correct HTTP 201 response from Fivetran’s REST API.

6. (Optional) Send a PATCH request to the Modify a Connector endpoint to make additional changes to any of the following:

   • Sync frequency
   • Daily sync time
   • Schedule type (auto or manual)
   • Authentication
   • Config parameters

7. Repeat Steps 1 through 5 to set up additional sources.

Considerations

• Our REST API is available only for Free, Standard, Enterprise, and Business Critical accounts.

• Powered by Fivetran customers can leverage this process programmatically to implement a smooth customer onboarding process for all of your SaaS applications or databases. See our Powered by Fivetran Quickstart Guide and Powered by Fivetran Detailed Guide for details.