WeaveKit Docs

Run a workflow action

Runs `submit` | `approve` | `reject` | `withdraw` | `cancel` | `forward`. RBAC-scoped, workitem-gated, atomic and audited. `forward` takes `{ to: { userId } }`; `approve`/`reject`/`withdraw` take `{ comment }`.

POST/api/objects/{name}/{id}/workflow/{action}

Runs submit | approve | reject | withdraw | cancel | forward. RBAC-scoped, workitem-gated, atomic and audited. forward takes { to: { userId } }; approve/reject/withdraw take { comment }.

Authorization

bearerAuth
AuthorizationBearer <token>

API key present in auth.source (or resolved by an AuthResolver).

In: header

Path Parameters

name*string

Object name from objects/<name>/schema.json.

id*string

Record id — the record_key encoding of the (possibly composite) primary key; returned as weave_id.

action*string

Declared workflow transition action name.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/objects/string/string/workflow/string"
{}