ZRM Docs
API ReferenceAutomation

automation.createRule

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
namestringYesName
descriptionstringNoDescription
enabledbooleanYestrueEnabled
triggerTypeenum(event, schedule, condition)YesTrigger type
triggerConfigobjectYesTrigger config
conditionsobjectNoConditions
actionTypeenum(create_record, update_status, send_notification, agent_review, run_workflow, create_reorder_po, create_agent_task, create_agent_task_and_dispatch)YesAction type
actionConfigobjectYesAction config
autonomyPolicyenum(auto_execute, draft_for_review, agent_review)Yes"draft_for_review"Autonomy policy
priorityintegerYes100Priority
cooldownMinutesintegerNoCooldown minutes
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "name": "Example Name",
  "description": "A description",
  "enabled": true,
  "triggerType": "event",
  "triggerConfig": null,
  "conditions": null,
  "actionType": "create_record",
  "actionConfig": null,
  "autonomyPolicy": "auto_execute",
  "priority": 100,
  "visibilityMode": "global"
}

On this page