Create a Connect Card
Generates the Connect Card URI for the connection
Request schema
Path parameters
The unique identifier for the connection within the Fivetran system.
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
An optional parameter that lets you show all fields on Connect Card including those that are hidden by default for certain connectors.
POST /v1/connections/connectionId/connect-card HTTP/1.1 Accept: application/json;version=2 Authorization: BasicContent-Type: application/json Host: api.fivetran.com Content-Length: 133 { "connect_card_config": { "redirect_uri": "https://your.site/path", "hide_setup_guide": true, "all_fields": true } }
Responses
200
Response status code
Response status text
The connection identifier
The connect-card auth token
The Connect Card URI for the user interface
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
An optional parameter that lets you show all fields on Connect Card including those that are hidden by default for certain connectors.
{ "code": "Success", "message": "Connection Connect Card has been created", "data": { "connector_id": "connection_id", "connect_card": { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU", "uri": "https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh..." }, "connect_card_config": { "redirect_uri": "https://your.site/path", "hide_setup_guide": true, "all_fields": true } } }