Skip to main content
GET
Get a realtime auth token

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"

X-Dynamic-Checkout-Session-Token
string

Checkout session token issued at transaction creation. Required when no JWT is provided. Format: dct_.

X-Dynamic-Checkout-Transaction-Id
string

UUID of the checkout transaction the request applies to. Required when authenticating via checkout session token, or to scope a realtime token to a checkout transaction.

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. The only allowed value is subscribe, which is also the default.

Example:

"subscribe"

Response

Realtime auth token

token
string
required

Short-lived JWT for subscribing to realtime channels.

Last modified on September 10, 2026