Engine · Available

Workflow

Phases, approvals, and execution history.

@keystone/engine-workflow

Purpose

Configurable process execution — templates, instances, phase graphs, deliverables, and approval gates. The package is Workflow; platform events use the flow.* family for the process lifecycle.

In a product

A quote that needs manager sign-off, or a work order that moves through stages — same engine, your phases, tasks, and approval teams.

How it works

  1. Authors define a template: phases, task templates (deliverables), and transitions (optional branch labels).
  2. Starting a workflow creates an instance pinned to a template revision, with linked entities when needed.
  3. People complete tasks; required deliverables must be done before a phase can advance.
  4. Approval gates (sequential or parallel, by opaque team id) can block a transition until signed off.
  5. The engine publishes flow.* events so Automation and Notification can react.

Capabilities

  • Workflow templates with phase graphs and branch labels
  • Graph validation (unique keys, valid refs, labeled multi-out edges)
  • Instances pinned to template revision with status lifecycle
  • Approval-gated transitions (sequential / parallel)
  • Task status updates and deliverable gates
  • Linked entities by type + id; subprocess support
  • Events: started, phase advanced/rejected, approval required, completed
  • API under /v1/workflows (templates, instances, tasks)

Related

Event · Tracker · Automation · Notification