Skip to content
Console
On this page

sylphx events

Every sylphx events command: its argument, its flags and a run line.

The events commands of Sylphx Events, as the CLI spells them: the same calls as the events API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

publish-service-event

Publishes a service's own event into a consenting tenant environment. Requires events:publish and the exact events:platform:<service> scope. A webhook_uri selects exactly one registered endpoint in that environment; admission atomically stores its signed, retried delivery, or stores nothing.

CLI

Shell
sylphx events publish-service-event

POST https://api.sylphx.com/v1/events:publishServiceEvent · scope events:publish · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe consenting tenant environment: orgs/{org}/projects/{project}/envs/{env}. Required.
--eventjsonsource must be sylphx.<service> and type must start with <service>. Required.
--webhook-uristringExact registered https endpoint URI; empty uses ordinary environment fan-out.

get

Gets an event.

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

CLI

Shell
sylphx events get orgs/acme/projects/shop/envs/production/events/event

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

list

Lists events.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx events list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/events · 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.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.