Skip to main content
POST
/
api
/
automations
Create a new automation
curl --request POST \
  --url https://your-instance.example.com/api/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "event": "<string>",
  "actions": {},
  "sourceStatuses": [
    "<string>"
  ],
  "maxTransitions": 123,
  "enabled": true,
  "triggerType": "<string>",
  "conditions": [
    {}
  ],
  "triggerLogicType": "<string>",
  "timerLogic": {
    "enabled": true,
    "delay": 2,
    "unit": "<string>"
  },
  "schedule": {
    "start": "<string>",
    "end": "<string>"
  },
  "maxFollowUpCount": 2
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
description
string
required
​
event
string
​
actions
object
​
sourceStatuses
string[]
​
maxTransitions
number
​
enabled
boolean
​
triggerType
string
​
conditions
object[]
​
triggerLogicType
string

Either "event" or "timer"

​
timerLogic
object
​
schedule
object
​
maxFollowUpCount
number
Required range: x >= 1

Response

Automation created successfully

Generic response envelope. Endpoint-specific fields are intentionally open.