Get a realtime auth token

Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.

GET /sdk/{environmentId}/realtime/auth

Get a realtime auth token

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/realtime/auth \
  --header 'Authorization: Bearer <token>'

200

{
  "token": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Dynamic-Flow-Session-Token · string

Flow session token issued at source attachment. Required when no JWT is provided. Format: dft_.

X-Dynamic-Flow-Id · string

Flow ID associated with the flow session token. Required when authenticating via flow session token instead of JWT.

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

capabilities · string

Comma-separated list of requested capabilities. Allowed values are subscribe and publish. Defaults to subscribe.

Example:

"subscribe,publish"

Response

200

application/json

Realtime auth token

token · string · required

Short-lived JWT for subscribing to realtime channels.