Skip to content
Console
On this page

Subscriptions

A Subscription fans each matching event of a Topic out to one Queue, Webhook Endpoint, or Realtime Channel: exactly one message per…

A Subscription fans each matching event of a Topic out to one Queue, Webhook Endpoint, or Realtime Channel: exactly one message per (subscription, event).

Service Sylphx Events · Resource type events.sylphx.com/Subscription · Name pattern orgs/{org}/projects/{project}/envs/{env}/subscriptions/{subscription} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/subscriptions/{subscription}.
uidstringsub_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specSubscriptionSpecDesired state. Required.
statusSubscriptionStatusObserved 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.

MethodCallWhat it does
GETgetGets a subscription.
GETlistLists subscriptions.
POSTcreateCreates a subscription.
PATCHupdateUpdates a subscription.
DELETEdeleteDeletes a subscription.

get

Gets a subscription.

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

list

Lists subscriptions.

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

create

Creates a subscription.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions · scope events:write · effect write · Request, response and examples

update

Updates a subscription.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions/subscription · scope events:write · effect write · Request, response and examples

delete

Deletes a subscription.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/subscriptions/subscription · scope events:write · effect destructive · Request, response and examples