ZRM Docs
Domain Model

Agent Task

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
taskTypestringYesTask type
sourceTypeenum(event, conversation, schedule, operator, workflow, automation_rule)YesSource type
sourceRefIdunknownYesID of the associated source ref
entityTypeunknownYesEntity type
entityIdunknownYesID of the associated entity
titlestringYesTitle
descriptionunknownYesDescription
prioritynumberYesPriority
statusenum(queued, planning, awaiting_approval, executing, blocked, completed, failed, canceled)YesStatus
assignedAgentRoleunknownYesAssigned agent role
executionModeenum(deterministic, agentic, hybrid)YesExecution mode
approvalPolicyenum(auto_execute, draft_for_review, agent_review, restricted)YesApproval policy
dueAtunknownYesDue at
startedAtunknownYesStarted at
completedAtunknownYesCompleted at
failedAtunknownYesFailed at
lastErrorunknownYesLast error
workspaceVisiblebooleanYesWorkspace visible
createdByUserIdunknownYesID of the associated created by user
workspaceIdstringYesID of the associated workspace
metadataunknownYesMetadata

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
taskTypestringYesTask type
sourceTypeenum(event, conversation, schedule, operator, workflow, automation_rule)YesSource type
sourceRefIdstringNoID of the associated source ref
entityTypestringNoEntity type
entityIdstringNoID of the associated entity
titlestringYesTitle
descriptionstringNoDescription
priorityintegerYes100Priority
assignedAgentRolestringNoAssigned agent role
executionModeenum(deterministic, agentic, hybrid)Yes"agentic"Execution mode
approvalPolicyenum(auto_execute, draft_for_review, agent_review, restricted)Yes"draft_for_review"Approval policy
dueAtstring.date-timeNoDue at
workspaceVisiblebooleanYestrueWorkspace visible
createdByUserIdstringNoID of the associated created by user
workspaceIdstringNoID of the associated workspace
metadataobjectNoMetadata

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
taskTypestringNoTask type
entityTypestringNoEntity type
entityIdstringNoID of the associated entity
titlestringNoTitle
descriptionstringNoDescription
priorityintegerNo100Priority
assignedAgentRolestringNoAssigned agent role
executionModeenum(deterministic, agentic, hybrid)No"agentic"Execution mode
approvalPolicyenum(auto_execute, draft_for_review, agent_review, restricted)No"draft_for_review"Approval policy
dueAtstring.date-timeNoDue at
workspaceVisiblebooleanNotrueWorkspace visible
metadataobjectNoMetadata

On this page