Quickstart

Create a policy, submit a request, and decide, in five minutes.

This walks through the shortest path from zero to an approved request.

1. Create a policy

A policy declares the stages a request passes through. The simplest policy has one stage that any holder of a role may approve:

{
  "name": "Document review",
  "scopeModel": "doc",
  "stages": [{ "order": 1, "name": "Review", "mode": "any_of", "approverRole": "reviewer" }]
}

2. Submit a request

The source app hands off an item for approval, referencing the policy and the target:

{ "policyId": "<policy-id>", "targetType": "doc", "targetId": "H1" }

3. Decide

The stage’s approvers see the request in their inbox and decide. On a terminal outcome the engine tells the source app to apply it.

Next: read about Policies.