Skip to main content
POST
Create event stream

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Information needed to create an event stream.

name
string
required

The name for the event stream.

connection_type
enum<string>
required

The type of event stream connection.

Available options:
WEBHOOK
webhook_url
string

The webhook URL. Required when connection_type is WEBHOOK.

credentials
object

Authentication credentials for a webhook connection.

Response

200 - application/json

The event stream just created. Credentials are returned in clear text only on creation.

An event streaming connection that publishes events to an external system.

event_stream_id
string<uuid>
required

The ID of the event stream.

connection
object
required

The connection configuration for an event stream.

Last modified on July 10, 2026