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. The token is always scoped to the channels of the resources the caller is entitled to: session tokens are scoped to their own transaction or flow, while JWT callers must name the flow and/or checkout transaction to follow via the X-Dynamic-Flow-Id and X-Dynamic-Checkout-Transaction-Id headers.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Flow session token issued at source attachment. Required when no JWT is provided. Format: dft_.
Flow ID associated with the flow session token. Required when authenticating via flow session token instead of JWT.
36^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"95b11417-f18f-457f-8804-68e361f9164f"
Checkout session token issued at transaction creation. Required when no JWT is provided. Format: dct_.
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.
36^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"95b11417-f18f-457f-8804-68e361f9164f"
Path Parameters
ID of the environment
36^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"95b11417-f18f-457f-8804-68e361f9164f"
Query Parameters
Comma-separated list of requested capabilities. The only allowed value is subscribe, which is also the default.
"subscribe"
Response
Realtime auth token
Short-lived JWT for subscribing to realtime channels.