Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Event Streams

Create an event stream

Creates a new event-stream subscription for the client. Event streams push a filtered view of client-event activity to a downstream consumer such as a webhook or Kafka topic. Returns the created event stream with its server-assigned id.

post/v6/event-streams

Request body

component_idsstring[]
stop_atstring

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

tagsstring[]

Example request

{
  "description": "handlebars@buildtime:{{description}}",
  "name": "handlebars@buildtime:{{name}}",
  "stop_at": "2025-10-24T09:00:00.000Z"
}

Response

Successful response

component_idsstring[] required
created_datestring required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

idstring required
stop_atstring required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

tagsstring[] required
updated_datestring required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Example response

{
  "created_date": "2025-10-24T09:00:00.000Z",
  "description": "handlebars@buildtime:{{description}}",
  "name": "handlebars@buildtime:{{name}}",
  "stop_at": "2025-10-24T09:00:00.000Z",
  "updated_date": "2025-10-24T09:00:00.000Z"
}