Trigger automation

POST

/api/v1/streams/{stream_id}/events

Fire an event at an automation for a contact. The payload (with a trigger's data-mappings) becomes {{key}} in steps.

Request

Authorization

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/json

Example

{
    "contact": {
        "phone_number": "string",
        "name": "string",
        "email": "string"
    },
    "property1": "string",
    "property2": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/streams/strm_1234abcd/events' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "contact": {
        "phone_number": "string",
        "name": "string",
        "email": "string"
    },
    "property1": "string",
    "property2": "string"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": "string"
}

🟠404Not found

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

Update automation

List triggers