Search documentation

Search for a topic, a control, or an event type.

    Docs / Start here / The platform / Approvals

    Approvals

    Approvals lists the requests that Human approval jobs hold for a person. Approving a request publishes its output event so the next jobs run. Rejecting it ends the job.

    A Human approval job prepares its output event and then holds it instead of publishing it. Each held event is a request on the Approvals page, where a person reads the instructions, checks the proposed values and decides. The job’s configuration, including its instructions, automatic approval rules and timeout, is described under the Human approval action.

    Approvals appears in the menu when human approval is enabled for the organisation. Without it, a waiting job’s request can still be decided from its detail in Logs.

    What the page shows

    The page opens on Pending. The filters Pending, All, Approved, Rejected and Expired choose which requests are listed. On a narrow screen they become one Approval status menu. Requests are listed newest first, 20 at a time, and Load more shows the next ones.

    Status
    pending, approved, rejected or expired, with the time the request was created.
    Time remaining
    For a pending request with a timeout, the time left and what happens then, such as On timeout: reject.
    Instructions
    The job’s approval instructions, with values from the incoming event filled in.
    Output Event Properties
    The proposed properties of the held event as JSON. Expand it to read or edit them.

    A card does not name the workflow or job that raised it, so the instructions carry the context a reviewer needs. The Approvals menu item shows the number of pending requests you can decide, up to 99+, and hides the number at zero. The list and the number refresh when a request is created or resolved.

    Approve or reject

    Approve
    Publishes the held output event. Jobs that listen for that event type start, and the approval job’s status becomes Succeeded.
    Reject
    Ends the job without publishing the event, so the jobs that wait for it do not run. The job’s status becomes Rejected.

    To change the values before approving, expand Output Event Properties and edit the JSON. Approve sends the edited object. Keys in it replace the proposed values or add new ones, and keys left out keep their proposed values. Approve stays disabled while the text shows Invalid JSON. Edits are sent only while the section is expanded.

    A request takes one decision. When another person or the timeout resolved it first, the attempt fails with Approval failed or Rejection failed and the request keeps its first outcome. A decision cannot be changed later, and approved, rejected and expired cards are read-only.

    Expired requests

    A request with a timeout is resolved automatically within about 30 seconds after its time runs out, unless a person decides first. It then has the expired status and appears under Expired. On timeout: approve publishes the proposed event without changes. On timeout: reject ends the job as Reject does. A request without a timeout stays pending until someone decides.

    Deciding from a run

    When a job is waiting for approval, its detail in Logs and Log Details shows the same card under Pending Approval, with the instructions, Output Event Properties, Reject and Approve.

    A test run from Run workflow approves every Human approval job automatically and creates no request. On a live workflow, Run workflow with Read, Write and Publish Events all on is a live run and creates a real request. The canvas then shows an Approval required card with the instructions, Reject and Approve. Approve there accepts the proposed values without edits.

    Who can decide

    Anyone who can see a workflow can see, approve and reject its requests. View access is enough, and an organisation Administrator reaches every workflow’s requests. To limit who decides, limit who has access to the workflow. A request from a job that belongs to no workflow is visible to everyone in the organisation.