POST /v1/connections/{connectionId}/connect-card
Generates the Connect Card URI for the connection
Servers
- https://api.fivetran.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId |
String | Yes |
The unique identifier for the connection within the Fivetran system |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | No |
Default value: "application/json;version=2" |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
connect_card_config |
Object | No | |
connect_card_config.hide_setup_guide |
Boolean | No |
An optional parameter that lets you hide the embedded setup guide in the Connect Card. |
connect_card_config.redirect_uri |
String | Yes |
The URI on your site we redirect the end user to after successful setup. The URI must start with the |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.