Mint a realtime handoff token
A short-lived credential for opening the realtime WebSocket from a context that shouldn’t hold the API key. Send {"data": {"token": "..."}} as the first WebSocket message before it expires; the connection then behaves exactly like an API-key connection (channels come from the key’s scopes at connect time, and the connection outlives the token). Daemons that hold the key can skip this endpoint and connect with {"data": {"apiKey": "..."}} directly. Requires a key with at least one realtime-capable scope. Guide: https://docs.tippage.com/api/realtime
/realtime/tokenAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
application/jsonexpires_inintegerToken lifetime in seconds (how long it can be used to connect).
groupsstring[]Narrow the token to a subset of the key's groups - so a broad key can hand out a token that only sees some of them. Every name must be a group the key's own scopes already grant (otherwise 403 group_not_granted); it can only narrow, never widen. Omit to grant everything the key allows.
Connection details.
urlstringThe raw WebSocket endpoint - no client library needed.
tokenstringSend as {"data": {"token": "..."}} in the first WebSocket message.
expires_atstring<date-time>channelsstring[]The channels this token will actually grant (the key's scopes, narrowed by groups if given).
groups was malformed or contained an unknown group name (bad_groups).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key has no realtime-capable scopes (no_realtime_scopes), or groups asked for one the key doesn't grant (group_not_granted).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring