Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx events realtime_messages
Every sylphx events realtime_messages command: its argument, its flags and a run line.
The realtime_messages commands of Sylphx Events, as the CLI spells them: the same
calls as the realtime_messages API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets one retained message of a channel.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx events realtime-messages get orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-messageGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message · scope events:read · effect read · Request, response and examples
#list
Lists a channel's retained messages, oldest first.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx events realtime-messages list orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channelGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages · scope events:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | Empty, or sequence > N to start after message N (resume). |