New: Kith open-sources its ATS.Read why
Skip to Content
Objects

CreateRealtimeTokenPayload

A token to listen for live changes in the caller's workspace.

type CreateRealtimeTokenPayload {
  channel: String!
  tokenRequest: String!
}

Fields

CreateRealtimeTokenPayload.channel · String! non-null scalar

The name of the channel to subscribe to: the workspace's own. A candidate.updated message on it carries { "candidateId": <id> }.

CreateRealtimeTokenPayload.tokenRequest · String! non-null scalar

A signed Ably token request, as JSON text. Parse it and hand the object to the Ably client's authCallback unchanged. It works once and soon expires.

Returned By

createRealtimeToken mutation