Create trigger

POST

/api/v1/streams/{stream_id}/triggers

Configure a trigger so the automation runs when an event arrives. Pick an expression_id (the WHEN) from GET /api/v1/expressions and supply its variables. data_mappings pull payload fields via JSONPath: recipient = who to message; variable = {{key}} in steps. The event source is derived from the expression automatically. Triggers start as draft; activate:true goes live (registers webhooks).

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/json

Example

{
    "condition": "string",
    "source": "string",
    "expression_id": "string",
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "event_source_id": "string",
    "activate": true,
    "description": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/streams/strm_1234abcd/triggers' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "condition": "string",
    "source": "string",
    "expression_id": "string",
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "event_source_id": "string",
    "activate": true,
    "description": "string"
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "id": "string",
    "stream_id": "string",
    "status": "draft",
    "description": "string",
    "condition": {
        "expression_id": "string",
        "topic": "string",
        "variables": {}
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}

🟠404Not found

🟠409Event source not connected / ambiguous

🟠422Validation failed

Modified at 2026-06-03 12:30:45

List triggers

Update trigger