Skip to content

Approval Flows

An approval flow is a running instance of a governance template. It tracks the state of a review from submission to final decision.

StateTransitions To
SubmittedIn Progress (reviewer assigned)
In ProgressApproved, Rejected, or Amendment Required
Amendment RequiredIn Progress (resubmitted)
ApprovedComplete
RejectedComplete

Templates define reviewer roles — not specific people. When a flow starts, Apiway resolves roles to actual users based on:

  • Organisational structure — Team leads, functional area owners
  • API ownership — The producing team’s designated reviewers
  • Escalation rules — If a reviewer doesn’t respond within a threshold, the flow escalates
Terminal window
# List pending approvals
curl https://core.api.apiway.net/v1/governance/approvals?status=pending \
-H "Authorization: Bearer $TOKEN"
# Submit a decision
curl -X POST https://core.api.apiway.net/v1/governance/approvals/{id} \
-H "Authorization: Bearer $TOKEN" \
-d '{
"outcome": "Approved",
"comments": "Looks good. Security model is solid."
}'

Each approval includes:

  • API specification — Full OAS with highlighted changes (for updates)
  • Compliance report — Score and individual violations
  • Recommendations — Design improvement suggestions
  • Governance history — Previous flows for this API
  • Submission context — Who submitted, when, and why

For lower-risk scenarios, templates can enable auto-approval. Common configurations:

  • Internal APIs in development environments → auto-approved
  • APIs with a compliance score above a threshold → auto-approved
  • Production deployments → always require manual approval

Completed flows include an SVG diagram showing the full approval graph — who was involved, what path the flow took, and the timeline. This is generated at completion and stored as a permanent audit record.

Apiway notifies reviewers and submitters at each state change:

  • Reviewer assigned — “You have a new approval waiting”
  • Decision made — “Your API was approved/rejected”
  • Amendment requested — “Changes are needed before this can proceed”
  • Escalation — “This approval has been escalated to you”