Skip to main content
Documentation

Processes Overview

Processes track multi-step workflows. Each process defines a series of steps — some automated, some requiring human input. Use processes to give operators visibility into where things stand.

Process Lifecycle

Created (running)
    |
    +---> Steps progress (step_started -> step_completed)
    |
    +---> Completed (all steps done)
    |
    +---> Failed (error occurred)

Process Model

FieldTypeDescription
process_idstringUnique identifier (UUID)
namespacestringOrg-qualified namespace (e.g., orgId.deployments)
namestringDisplay name
descriptionstringOptional description
statusstringrunning, completed, failed
current_stepstringKey of the currently active step
step_defsarrayStep definitions
timelinearrayStep execution history
task_idsarrayIDs of linked tasks
started_atstringISO 8601 timestamp
completed_atstringISO 8601 timestamp (when completed)

Linking Tasks to Processes

When creating a task, include process_id and process_step to link it to a process. When the task completes, the process step auto-completes with a step_completed event.

{
  "title": "Approve release",
  "process_id": "proc-uuid",
  "process_step": "approval",
  "steps": [...]
}