REST API FAQ
Read answers to frequently asked questions about the Fivetran REST API.
How do destinations and groups relate?
The destination is a cloud data warehouse, a database, an online data platform, or a data lake that your Fivetran connector replicates your source data to. A group maps users to the destination. We map a group to its destination on a 1:1 basis. This means that destination_id
, group_id
, and destination_group_id
fields in our REST API denote both the destination and group ID.
When you use our REST API, you manage connectors and transformations using our Destination Management REST API resource destination, and users - using our Group Management REST API resource.
How can I make sure that connectors created on behalf of my end-users are easily identifiable?
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 create a destination using the API?
You can either use the Create a Group endpoint to create a new group in your account or the List All Groups endpoint to select an existing group. Then, you can use the Create a Destination endpoint to create a destination in that group. Lastly, you can use the Create a Connector endpoint to create connectors in the destination.
What is a Connect Card?
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?
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?
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?
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.
How can I embed a Function connector?
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 through 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?
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 can I update a Facebook access token using the REST API?
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?
Learn how in our How Can I Find Out the Name of the Connector for which I Receive Events Using Webhooks page.