Connect Cardlink

Connect Card lets you collect credentials directly from your end users to set up connectors in Fivetran. First, use our API to create a connector and then render the Connect Card to your end user so that they can authorize the connector. Once authorized, the connector will be complete and initial sync can start just like a connector within the Fivetran dashboard.

To use Connect Card, complete the following steps:

1. Create a connector using the create a connector API endpoint and get the connector ID from the API response.

   Note: Since the connector is created without specifying authorization parameters, we strongly recommend setting the value of the run_setup_tests parameter to false. This will greatly speed up creating connectors through the API.

2. Use the connector ID to create a Connect Card token. The lifetime of this token is one day.

   Request

   POST api.fivetran.com/v1/connectors/{connector_id}/connect-card-token
   

   Payload

   The request body must be empty.

   Response

   HTTP 200 OK

   {
     "token": "{connect_card_token}"
   }
   

3. Redirect your end user to the Connect Card URL in your user interface, which can be formed in the following way:

   https://fivetran.com/connect-card/setup?redirect_uri={redirect_uri}&auth={connect_card_token}

   https://fivetran.com/connect-card/setup?redirect_uri={redirect_uri}&auth={connect_card_token}&hide_setup_guide=true

   Query parameters

   Name	Description
   redirect_uri (required)	The URI on your site where we will redirect the end user after successful setup. The URI must start with the https or http prefix.
   connect_card_token (required)	Connect card access token requested in step 2.
   hide_setup_guide (optional)	Optional parameter that lets you hide the embedded setup guide in the Connect Card UI

   Your end user will see the following page that allows them to authorize the connector and change connector settings:

4. After authorization, the end user will click Save & Test. If the tests pass, the page will be redirected to redirect_uri specified in step 3 with the query parameter redirect_uri={redirect_uri}. If the tests fail, the page will not be redirected and the end user will be able to reauthorize the connector or change connector settings.

5. After successful connector authorization, you can update connector settings through the Fivetran dashboard or through the Modify a Connector public API endpoint.

Note: See our Connector Management documentation.