Auth

Create Link Token

Changed on

Creates a temporary link token that is required to initiate the react-trackstar-link component. See the Getting Started guide for more details.

post/link/token

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/link/token
  • Auth
    none required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Request body

connection_idstring

An optional existing connection ID. If provided, the connection is reinstalled instead of a new connection being created.

customer_idstring

An optional identifier for your end customer. If provided, it is recorded on any failed install attempts made with this link token and carried onto the connection once it is created, so you can trace either back to a specific customer.

Example request

{
  "connection_id": "existing_connection_id",
  "customer_id": "customer_id"
}

Response

Successful response

link_tokenstring required

The link token that is required to initiate the react-trackstar-link component.

Example response

{
  "link_token": "your_link_token"
}

Changes