Skip to main content

Events REST reference

Endpoints for listing events and managing subscriptions. TaruviBase fires events itself; there is no endpoint to publish one.

Authentication​

Every endpoint requires a credential — see Authentication and authorization. Subscribing, unsubscribing, and listing an app's subscribers also require an organization owner or admin, or another cloud user with access to the site.

List events​

MethodPathSuccessWho can call
GET/api/cloud/events/200Any signed-in caller

The response's data.events is a list of event names.

Subscribe​

MethodPathSuccessWho can call
POST/api/cloud/events/{event_name}/subscribe/201Cloud access

Request body:

FieldTypeRequired
function_idintegerYes — the id of an existing function

{event_name} must match an event type exactly, including case.

The response includes the subscription's id, event, function, function_name, function_slug, app_name, app_slug, and timestamps.

Unsubscribe​

MethodPathSuccessWho can call
POST/api/cloud/events/{event_name}/unsubscribe/200Cloud access

Same request body as subscribe. If the function isn't subscribed, the request returns an error — see Troubleshooting.

List an app's subscribers​

MethodPathSuccessWho can call
GET/api/apps/{app_slug}/events/{event_name}/200Cloud access
FieldTypeMeaning
eventstringEvent name
appobject{ id, name, slug }
total_subscribersintegerNumber of this app's subscribed functions
subscribersarrayOne entry per subscribed function

Each subscriber includes subscriber_id, event, function_id, function_name, function_slug, filter_conditions, app identifiers, and created_at.

ErrorStatusCause
Unknown app404No app with that slug
Unknown event name400Not an event type
Not allowed403The caller doesn't have cloud access