Skip to main content
POST
Create a stream trigger

Authorizations

Authorization
string
header
required

JWT token for authentication. Required for all API operations to verify identity and access permissions.

Body

application/json
name
string
required

Unique name identifier for the trigger. Used to construct the trigger's topic and subject.

Example:

"my-stream-trigger"

trigger_type
enum<string>
required

Must be 'stream' for this endpoint. Determines the trigger's behavior and available properties.

Available options:
stream
Example:

"stream"

source
object
required
target
object
required
collection
string

Logical grouping the trigger belongs to. Used for organizing and filtering triggers.

Example:

"my-collection"

description
string

Human-readable description explaining the trigger's purpose and function.

Example:

"Stream data processing trigger"

Response

Stream trigger created successfully

body
object
status_code
integer

HTTP status code indicating the result of the operation.

Example:

201