Events API

Event bus — publish/subscribe

REST API endpoints for Events. 11 operations.

Delete a subscription

plaintext

DELETE /v1/events/subscriptions/{id}

Removes an event subscription by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Subscription id

Responses

Status	Description
`200`	Subscription deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteEventSubscription

Get a subscription

plaintext

GET /v1/events/subscriptions/{id}

Returns a single event subscription by id.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Subscription id

Responses

Status	Description
`200`	Subscription details
`401`	Missing or invalid API key
`500`	Internal error

operationId: getEventSubscription

List subscription deliveries

plaintext

GET /v1/events/subscriptions/{id}/deliveries

Returns the delivery attempts for an event subscription.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Subscription id

Responses

Status	Description
`200`	Delivery attempts
`401`	Missing or invalid API key
`500`	Internal error

operationId: listSubscriptionDeliveries

List topics

plaintext

GET /v1/events/topics

Returns all event-bus topics for the caller's project.

Auth: Bearer API key

Responses

Status	Description
`200`	Topic list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listEventTopics

Create a topic

plaintext

POST /v1/events/topics

Creates a new event-bus topic.

Auth: Bearer API key

Responses

Status	Description
`201`	Topic created
`401`	Missing or invalid API key
`500`	Internal error

operationId: createEventTopic

Delete a topic

plaintext

DELETE /v1/events/topics/{id}

Removes an event-bus topic by id or name.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Responses

Status	Description
`200`	Topic deleted
`401`	Missing or invalid API key
`500`	Internal error

operationId: deleteEventTopic

Get a topic

plaintext

GET /v1/events/topics/{id}

Returns a single event-bus topic by id or name.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Responses

Status	Description
`200`	Topic details
`401`	Missing or invalid API key
`500`	Internal error

operationId: getEventTopic

List events on a topic

plaintext

GET /v1/events/topics/{id}/events

Returns the recent events published to a topic.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Responses

Status	Description
`200`	Events on the topic
`401`	Missing or invalid API key
`500`	Internal error

operationId: listTopicEvents

Publish an event

plaintext

POST /v1/events/topics/{id}/publish

Publishes an event payload to a topic.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Request body

application/json (required) — schema object.

Responses

Status	Description
`200`	Event published
`401`	Missing or invalid API key
`500`	Internal error

operationId: publishEvent

List a topic's subscriptions

plaintext

GET /v1/events/topics/{id}/subscriptions

Returns the subscriptions attached to a topic.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Responses

Status	Description
`200`	Subscription list
`401`	Missing or invalid API key
`500`	Internal error

operationId: listTopicSubscriptions

Create a subscription

plaintext

POST /v1/events/topics/{id}/subscriptions

Creates a subscription that delivers a topic's events to an endpoint.

Auth: Bearer API key

Parameters

Name	In	Type	Required	Description
`id`	path	`string`	Yes	Topic id or name

Request body

application/json (required) — schema object.

Responses

Status	Description
`201`	Subscription created
`401`	Missing or invalid API key
`500`	Internal error

operationId: createEventSubscription