Skip to main content
POST
Create automation rule

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
name
string
required

Rule name (required)

Required string length: 1 - 200
triggerType
enum<string>
required

Trigger type (required)

Available options:
date_threshold,
scheduled,
field_change,
absence
triggerConfig
object
required

Trigger-specific configuration (required)

entityType
enum<string>
required

Entity type (required)

Available options:
device,
company,
compliance,
planner,
user,
goal,
training,
ticket,
meeting
conditions
null[]
required

Condition groups (required)

actions
null[]
required

Actions to execute (required)

description
string

Rule description

Maximum string length: 1000
isActive
boolean
default:false

Whether to activate the rule immediately

priority
integer
default:0

Rule priority (0-100)

Required range: 0 <= x <= 100
scopeType
enum<string>
default:tenant

Rule scope

Available options:
tenant,
company
companyIds
string<uuid>[]

Company IDs for company-scoped rules

aggregationConfig
any | null

Aggregation configuration

Response

Rule created successfully

data
object
required