Skip to main content
POST
Create Realtime Token

Authorizations

X-API-Key
string
header
default:sk_live_your_api_key_here
required

Workspace-scoped API key. Format: sk_live_{64 hex chars}

Path Parameters

submission_id
string<uuid>
required

Response

Successful Response

Ably token request granting subscribe-only access to a submission channel.

Relay this object verbatim to the Ably client SDK (e.g. via authCallback) to authenticate a subscription to the submission's realtime channel.

keyName
string
required

Ably key name the token is signed with

ttl
integer
required

Token lifetime in milliseconds

capability
string
required

Granted capability (JSON): subscribe on the submission channel

timestamp
integer
required

Signing timestamp (ms since epoch)

nonce
string
required

Unique nonce for the signed token request

mac
string
required

HMAC signature of the token request

clientId
string | null

Client identity stamped on the token