Skip to content
Console
On this page

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

Shell
sylphx events realtime-messages get orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message

GET 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

Flags

FlagTypeWhat it does
--client-idstringChat viewer; required on Chat channels.

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

Shell
sylphx events realtime-messages list orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel

GET 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

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringEmpty, or sequence > N to start after message N (resume).
--client-idstringChat viewer; required on Chat channels. The trusted tenant backend binds identity.
--after-cursorstringExclusive cursor, for forward recovery. Cannot combine with before_cursor or filter.
--before-cursorstringExclusive cursor, for backwards history, newest first. Cannot combine with after_cursor or filter.

react

Adds or removes a member reaction on a visible Chat message.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx events realtime-messages react orgs/acme/projects/shop/envs/production/realtime_channels/realtime-channel/realtime_messages/realtime-message

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

Flags

FlagTypeWhat it does
--client-idstringAuthenticated reacting member.
--emojistringEmoji, at most 32 UTF-8 bytes.
--removeboolRemove instead of add.