Skip to content
Console
On this page

Topics

A Topic is a named stream producers publish CloudEvents into.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A Topic is a named stream producers publish CloudEvents into. An event is immutable and deduplicated by source + id within the Topic; a different payload under the same pair is a conflict, never a second fact.

Service Sylphx Events · Resource type events.sylphx.com/Topic · Name pattern orgs/{org}/projects/{project}/envs/{env}/topics/{topic} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/topics/{topic}.
uidstringtop_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specTopicSpecDesired state. Required.
statusTopicStatusObserved 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 topic.
GETlistLists topics.
POSTcreateCreates a topic.
PATCHupdateUpdates a topic.
DELETEdeleteDeletes a topic.
POSTpublishPublishes CloudEvents into a Topic, atomically. Replaying the same source + id with the same payload returns the stored event; a different payload fails with RESOURCE_ALREADY_EXISTS.

get

Gets a topic.

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

list

Lists topics.

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

create

Creates a topic.

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

update

Updates a topic.

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

delete

Deletes a topic.

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

publish

Publishes CloudEvents into a Topic, atomically. Replaying the same source + id with the same payload returns the stored event; a different payload fails with RESOURCE_ALREADY_EXISTS.

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