---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Realtime channels"
description: "The `realtime_channels` collection of Sylphx Events: A Realtime Channel delivers matching events to authorized clients over WebSocket or SSE, resumable from a cursor."
type: reference
product: realtime
summary: "A Realtime Channel delivers matching events to authorized clients over WebSocket or SSE, resumable from a cursor."
updated: 2026-09-28
order: 900
---

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

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/realtime_channels/{realtime_channel}`. |
| `uid` | `string` | `rtc_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `RealtimeChannelSpec` | Desired state. Required. |
| `status` | `RealtimeChannelStatus` | Observed 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/realtime_channels#get) | Gets a realtime channel. |
| `GET` | [`list`](/docs/api/realtime_channels#list) | Lists realtime channels. |
| `POST` | [`create`](/docs/api/realtime_channels#create) | Creates a realtime channel. |
| `PATCH` | [`update`](/docs/api/realtime_channels#update) | Updates a realtime channel. |
| `POST` | [`publish`](/docs/api/realtime_channels#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` | [`issue_token`](/docs/api/realtime_channels#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. |
| `DELETE` | [`delete`](/docs/api/realtime_channels#delete) | Deletes a realtime channel. |

## 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](/docs/api/realtime_channels/get)

## 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](/docs/api/realtime_channels/list)

## 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](/docs/api/realtime_channels/create)

## 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](/docs/api/realtime_channels/update)

## 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](/docs/api/realtime_channels/publish)

## 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](/docs/api/realtime_channels/issue_token)

## 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](/docs/api/realtime_channels/delete)