Skip to content

workflow-definition schema

A real multi-stage approval workflow (engine-workflow) — stagesJson/tasksJson/transitionsJson (each itself a JSON-encoded string) + a top-level approvalPermissions array.

Pull the full JSON Schema: erp schema pull workflow-definition  ·  MCP: erp_get_schema {"name":"workflow-definition"}

Top-level properties

PropertyTypeRequiredNotes
namestringyesUnique per tenant; a domain module's REST layer starts instances by this exact name, e.g. "employee.transfer".
descriptionstring
stagesJsonstringyes
tasksJsonstringyes
transitionsJsonstringyes
approversJsonstring
slasJsonstring
escalationsJsonstring
notificationsJsonstring
metadataJsonstring
approvalPermissionsarrayWhich role (by its stable role.code, never a mutable display name) may decide which named approvalObject task.