Sign in

v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB
Auth

Create Magic Link

Create a Magic Link to allow users to connect their integrations via a temporary link.

post/magic-links

Headers

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

Your organization-level Trackstar API key.

Request body

connection_idstring nullable

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

integration_allow_liststring[]

Integrations that your users will be allowed to install. Mutually exclusive with integration_block_list and integrations_with_endpoints.

integration_block_liststring[]

Integrations that your users will not be allowed to install. Mutually exclusive with integration_allow_list.

integrations_with_endpointsstring[]

Only show integrations that support these endpoints. Mutually exclusive with integration_allow_list.

integration_type'wms' | 'freight' | 'cart' | 'carrier' | 'erp'

The type of integration to filter by.

link_durationinteger

The number of days you want this magic link to be active.

customer_idstring nullable

An identifier for your end customer.

Example request

{
  "integration_allow_list": [
    "shipbob"
  ],
  "integration_block_list": [
    "shipbob"
  ],
  "integrations_with_endpoints": [
    "get_inventory",
    "get_products",
    "create_order"
  ],
  "link_duration": 7,
  "customer_id": "customer_id"
}

Response

Successful response

Example response

{
  "magic_link": {
    "id": "c0a4fef52f664ecf9e766c16811c3289",
    "url": "https://link.trackstarhq.com/c0a4fef52f664ecf9e766c16811c3289",
    "expires_at": "2025-09-17T15:01:41Z",
    "integration_type": "wms",
    "integration_allow_list": [
      "shipbob"
    ],
    "integration_block_list": [
      "extensiv-3pl-central"
    ],
    "integrations_with_endpoints": [
      "get_inventory"
    ],
    "customer_id": "customer-123"
  }
}