Skip to main content
POST
Create a gateway 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-gateway-trigger"

trigger_type
enum<string>
required

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

Available options:
gateway
Example:

"gateway"

gateway_mapping
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:

"Trigger for API gateway endpoint"

Response

Gateway trigger created successfully

body
object
status_code
integer

HTTP status code indicating the result of the operation.

Example:

201