Create a new activation connect link Public Preview

Create a new activation Connect Link, which can be used to collect your customers' credentials when creating an activation. Read more on how to use Connect Links in our Activations in Powered by Fivetran How-to Guides.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

type

stringrequired

The type of activation to be managed by this link.

example:

hubspot

group_id

stringrequired

The unique identifier of the group that this Connect Link should be associated with.

example:

wandering_aimlessly

redirect_uri

string | null

The redirect URI, if any, associated with the Connect Link. The URL that you'd like the end-user to be redirected to after authorizing the activation. We do not forward the OAuth code or token to this URL.

format:

uri

example:

https://your-app.example.com/oauth/callback

Http + 1.1

POST

https://app.getcensus.com/api/v2/activation_connect_links

POST /api/v2/activation_connect_links HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 125

{
  "type": "hubspot",
  "group_id": "wandering_aimlessly",
  "redirect_uri": "https://your-app.example.com/oauth/callback"
}

Responses

201

Activation connect link created successfully.

400

The request could not be processed, e.g. an invalid `type` or `group_id` was provided.

401

Invalid credentials for the requested resource.

404

Resource not found.

`201`

status

string

Outcome of the operation.

example:

success

data

object

integerrequired

The unique ID associated with the Connect Link.

example:

469

type

string

The type of activation to be managed by this link.

example:

hubspot

expiration

stringrequired

The date and time when the Connect Link will expire.

format:

date-time

example:

2027-09-28T23:42:47.239Z

expired

boolean

A boolean value indicating whether the Connect Link has expired or not.

revoked

booleanrequired

A boolean value indicating whether the Connect Link has been revoked or not.

uri

stringrequired

The authorization URL that you will provide to end-users that begins the Fivetran-hosted flow to authorize an activation into your workspace.

format:

uri

example:

https://app.fivetran.com/pbc?auth=expiring_auth_key

redirect_uri

string | null

format:

uri

example:

https://your-app.example.com/oauth/callback

group_id

string

The unique identifier of the group associated with this Connect Link.

example:

wandering_aimlessly

`400`

status

integer

HTTP status code.

enum:

"400"

message

string

Description of the validation error.

example:

Invalid type: not_a_real_type

`401`

status

integer

HTTP status code.

enum:

"401"

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "success",
  "data": {
    "id": 469,
    "type": "hubspot",
    "expiration": "2027-09-28T23:42:47.239Z",
    "expired": false,
    "revoked": false,
    "uri": "https://app.fivetran.com/pbc?auth=expiring_auth_key",
    "redirect_uri": "https://your-app.example.com/oauth/callback",
    "group_id": "wandering_aimlessly"
  }
}