Skip to main content
POST
Create an automation rule

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
name
string
required

Unique across rules.

Maximum string length: 255
Example:

"Note large orders"

trigger
string
required

A name from triggers in GET /automations/schema.

Example:

"order_updated"

conditions
object[]
required

Required (may be empty — an empty list matches every record). Replaces the existing list on update.

actions
object[]
required

Required (may be empty). Replaces the existing list on update; any id sent is ignored.

status
enum<string> | null

Omitted on create means paused (the rule does not run until activated). Omitted on update leaves the current status. Set active only after a live test with POST /automations/runs.

Available options:
active,
paused,
error
summary
string | null

Optional. When omitted, a summary is generated in the background.

Maximum string length: 1000

Response

Rule created.

data
object

An automation rule — the same rules edited under Automations in the app.