REST API FAQlink
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 {customer_name}_connector_type.
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 How to Set a Custom Sync Frequency page.
Can I create a new connector based on an existing connector's parameters?link
Yes. See our How to Create a New Connector Based on an Existing Connector's Parameters documentation.
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.
How can I set up Powered by Fivetran to embed data pipelines into my product?link
Read our or Powered by Fivetran Quickstart Guide and Powered by Fivetran Detailed Guide to learn everything you need to get started with PBF.
How do I access the Fivetran REST API?link
Learn how in our Access REST API page.
Can I interact with Fivetran REST API using Python?link
Yes. Learn how in our Working with REST API Using Python page.
How can I run a manual sync and poll for completion using the REST API or webhooks?link
Learn how in our How to Run a Manual Sync and Poll for Completion Using the REST API or Webhooks page.
How do I back up a connector’s schema?link
Learn how in our Backup Connector Schema page.
How do I find the Connector ID?link
Learn how in our Find Connector ID page.
Can I set up connectors programmatically?link
Yes. Learn how in our programmatic connector setup page.
Why is the Fivetran API refusing my connection requests?link
Learn why in our Connection Refused page.
What does the exclude_mode Parameter Do?link
Learn about this parameter in the Exclude_mode API parameter page.
How can I copy the schema selection from one connector to another connector?link
Learn how in our Copy the schema selection from one connector to another page.
How can I do a historical sync using the REST API?link
Learn how in our How to do a historical sync using the REST API page.
How can I update a Facebook access token using the REST API?link
Learn how in our How to update a Facebook access token using the REST API page.
How can I find out the name of the connector for which I receive events using webhooks?link
Learn how in our How to find out the name of the connector for which the webhook is set up page.