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
sylphx events publish-service-eventPOST https://api.sylphx.com/v1/events:publishServiceEvent · scope events:publish · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The consenting tenant environment: orgs/{org}/projects/{project}/envs/{env}. Required. |
--event | json | source must be sylphx.<service> and type must start with <service>. Required. |
--webhook-uri | string | Exact 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
sylphx events get orgs/acme/projects/shop/envs/production/events/eventGET 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
sylphx events list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/events · 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 | AIP-160 filter over labels and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |