Create automation

POST

/api/v1/streams

Create a Stream automation. execution_mode defaults to definition_driven when a definition is present. Publishing validates the definition.

Request

Authorization

Add parameter in header

Authorization

Example:

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

Body Params application/json

Example

{
    "name": "string",
    "description": "string",
    "status": "draft",
    "execution_mode": "backend_driven",
    "business_phone_number": "string",
    "backend_url": "string",
    "definition": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/streams' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "description": "string",
    "status": "draft",
    "execution_mode": "backend_driven",
    "business_phone_number": "string",
    "backend_url": "string",
    "definition": {}
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "draft",
    "execution_mode": "backend_driven",
    "phone_number": "string",
    "backend_url": "string",
    "definition": {},
    "created_at": "string",
    "updated_at": "string"
}

🟠422Validation failed

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

List automations

Get automation