ZRM Docs
Domain Model

Automation Rule

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
namestringYesName
descriptionunknownYesDescription
enabledbooleanYesEnabled
triggerTypeenum(event, schedule, condition)YesTrigger type
triggerConfigobjectYesTrigger config
conditionsunknownYesConditions
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)YesAutonomy policy
prioritynumberYesPriority
cooldownMinutesunknownYesCooldown minutes
lastFiredAtunknownYesLast fired at
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

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

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
descriptionstringNoDescription
enabledbooleanNotrueEnabled
triggerTypeenum(event, schedule, condition)NoTrigger type
triggerConfigobjectNoTrigger config
conditionsobjectNoConditions
actionTypeenum(create_record, update_status, send_notification, agent_review, run_workflow, create_reorder_po, create_agent_task, create_agent_task_and_dispatch)NoAction type
actionConfigobjectNoAction config
autonomyPolicyenum(auto_execute, draft_for_review, agent_review)No"draft_for_review"Autonomy policy
priorityintegerNo100Priority
cooldownMinutesintegerNoCooldown minutes

On this page