Skip to main content
POST
Create automation

Body

application/json
name
string
required
Required string length: 1 - 120
trigger
object
required

When the automation fires. Every automation can also be fired on demand through the trigger endpoint.

action
object
required

What the automation does when it fires.

description
string
Maximum string length: 500
isEnabled
boolean

Defaults to true.

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
automation
object
required