Connect Card
Generates the Connect Card URI for the connector
Request schema
Path parameters
connectorId
stringrequired
The unique identifier for the connector within the Fivetran system
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
connect_card_config
object
redirect_uri
stringrequired
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
example:
hide_setup_guide
boolean
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
example:
hide_branding
boolean
writeOnly:
Http + 1.1
POST
https://api.fivetran.com/v1/connectors/connector_id/connect-card
POST /v1/connectors/connector_id/connect-card HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 136
{
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true,
"hide_branding": true
}
}Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
connect_card
object
token
string
The connect-card auth token
example:
uri
string
The Connect Card URI for the user interface
example:
connector_id
stringrequired
The connector identifier
example:
connect_card_config
object
redirect_uri
stringrequired
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
example:
hide_setup_guide
boolean
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
example:
hide_branding
boolean
writeOnly:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"connect_card": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkIjp7ImxvZ2luIjp0cnVlLCJ1c2VyIjoiX2FjY291bnR3b3J0aHkiLCJhY2NvdW50IjoiX21vb25iZWFtX2FjYyIsImdyb3VwIjoiX21vb25iZWFtIiwiY29ubmVjdG9yIjoiY29iYWx0X2VsZXZhdGlvbiIsIm1ldGhvZCI6IlBiZkNhcmQiLCJpZGVudGl0eSI6ZmFsc2V9LCJpYXQiOjE2Njc4MzA2MzZ9.YUMGUbzxW96xsKJLo4bTorqzx8Q19GTrUi3WFRFM8BU",
"uri": "https://fivetran.com/connect-card/setup?auth=eyJ0eXAiOiJKV1QiLCJh..."
},
"connector_id": "connector_id",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true,
"hide_branding": true
}
}
}