Skip to content
Console
On this page

Realtime channels

A Realtime Channel delivers matching events to authorized clients over WebSocket or SSE, resumable from a cursor.

A Realtime Channel delivers matching events to authorized clients over WebSocket or SSE, resumable from a cursor. Subscriptions route events into it; Notify's inbox rides it.

Service Sylphx Events · Resource type events.sylphx.com/RealtimeChannel · Name pattern orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}.
uidstringrtc_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specRealtimeChannelSpecDesired state. Required.
statusRealtimeChannelStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a realtime channel.
GETlistLists realtime channels.
POSTcreateCreates a realtime channel.
PATCHupdateUpdates a realtime channel.
POSTpublishPublishes one message to the channel: it is appended to the channel's history and pushed to every connected client. A retry with the same Idempotency-Key returns the first message.
POSTissue_tokenMints a subscribe token (rtt_…) for this channel alone, at most an hour long, for a browser or device that holds no key. A token that names a client id enters the channel's presence while it is connected.
DELETEdeleteDeletes a realtime channel.
POSTjoinJoins a persistent Chat conversation.
POSTleaveLeaves Chat while retaining durable read state.

get

Gets a realtime channel.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel · scope events:read · effect read · Request, response and examples

list

Lists realtime channels.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels · scope events:read · effect read · paginated · Request, response and examples

create

Creates a realtime channel.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels · scope events:write · effect write · Request, response and examples

update

Updates a realtime channel.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel · scope events:write · effect write · Request, response and examples

publish

Publishes one message to the channel: it is appended to the channel's history and pushed to every connected client. A retry with the same Idempotency-Key returns the first message.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:publish · scope events:publish · effect write · Request, response and examples

issue_token

Mints a subscribe token (rtt_…) for this channel alone, at most an hour long, for a browser or device that holds no key. A token that names a client id enters the channel's presence while it is connected.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:issueToken · scope events:publish · effect write · Request, response and examples

delete

Deletes a realtime channel.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel · scope events:write · effect destructive · Request, response and examples

join

Joins a persistent Chat conversation.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:join · scope events:write · effect write · Request, response and examples

leave

Leaves Chat while retaining durable read state.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel:leave · scope events:write · effect write · Request, response and examples