Read answers to frequently asked questions about the Fivetran REST API.
How can I make sure that connectors created on behalf of my end-users are easily identifiable?link
Use a connector naming policy that maintains clear differentiation by customers in a destination. Follow a naming pattern such as
For example, imagine you created a Salesforce connector for your end-user,
customer_name = apple. Using this naming policy, you’d name the connector
apple-salesforce. This name would appear in the Fivetran dashboard and as the schema name in the destination.
How do I connect to a warehouse using the API?link
You can only create a new destination using your Fivetran dashboard. But once you do that, you can easily load new connectors into an existing destination using the Connector Management API.
What is a Connect Card?link
Connect Cards let your end users create a connector in your Fivetran account using their own credentials and without logging in. Your users enter their credentials in a Fivetran pop-up window to create and test a new connector. Once the connector setup is complete, you’ll see it in your Fivetran dashboard. You can either manage the connector in your Fivetran dashboard or manage it programmatically using the API. Connect Cards eliminate any credential management or sharing between you and your end users.
Can I customize the look and feel of the Connect Card?link
You can’t customize the end-user experience in the redirect URL. However, everything up until then is your own. We expect that the end-user will interact with the Connect Card for approximately 30 seconds to 5 minutes, depending on the connector type.
Can I put Connect Card in an iframe?link
No, because iframes pose security risks, such as clickjacking. We deny opening fivetran.com in iframes by setting the header to x-frame-options: SAMEORIGIN.
Can I apply a custom schema to a connector using Connect Card?link
Yes. First, set up a Connect Card for your connector. Next, use the Retrieve a connector schema config endpoint to review the schema for that connector. Finally, use the Modify a connector schema config endpoint to adjust the inclusion of schemas, tables, and columns as the connector permits.
If you want to give your end user more control, you can also use the same endpoints to build data selection into your user interface.
Can I customize my connector’s sync schedule using the REST API?link
Yes. Learn how in our custom sync scheduling documentation.
Can I create a new connector based on an existing connector’s parameters?link
Yes. See our Use Case.
How can I embed a Function connector?link
We do not recommend using Connect Card with our Function connectors. Instead, set up functions using the API. You can reuse a function that you’ve created and create a new connector for each end-user. Then, share the relevant authentication information via the create a connector endpoint. For example, for Azure Functions, you’d have your end-user share the “secrets” that are relevant to the function that you created.