Skip to main content
POST
/
api
/
v1
/
event-triggers
/
register
Error
A valid request URL is required to generate request examples

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string
required

Project ID

Body

application/json

Request to register an event trigger

​
batch_size
integer<int32>
required

Number of events to batch before triggering

​
deployment_id
string
required

Deployment ID

​
event_topic
string
required

Topic to listen for events

​
workflow_id
string
required

Workflow ID to trigger

​
batch_timeout_seconds
integer<int32> | null

Timeout in seconds for batching

​
queue_name
string | null

Queue name for triggered executions

Response

Event trigger registered