Documentation Index
Fetch the complete documentation index at: https://docs.royaltyport.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Review step creates a human-in-the-loop approval gate in your workflow. When it executes, a message is created in the target project and appears in the organization’s Messages inbox. Team members can view the review data, discuss it via replies, and approve it to resume the workflow. This is useful when you need manual sign-off before continuing — for example, verifying extracted contract data, approving a batch of notifications before they’re sent, or reviewing transformed data before it’s written to a database.How It Works
Review Step Executes
The automation reaches the Review step and creates a message in the target project.
Team Reviews
A team member opens the message, reviews the key-value data, and can add replies or assign it to someone.
Configuration
| Field | Description |
|---|---|
| Review Mode | Wait or Continue (see below) |
| Title | Message title (supports template variables) |
| Description | Message description (supports template variables) |
| Link | Optional URL to attach to the review message. Reviewers see an Open button that opens the URL in a new tab. Supports template variables — useful for linking directly to a specific contract, recording, or external resource. Must resolve to a URL starting with http:// or https://. |
| Review Data | Key-value pairs of data to display to the reviewer (supports template variables) |
The target project where review messages are created is determined automatically from the
{{var.project-id}} variable in your composer. You no longer need to configure a project on the step itself.Review Modes
| Mode | Workflow Behavior | Action Required |
|---|---|---|
| Wait | Pauses at this step until a team member acts | Yes — click Approve to resume or Reject to stop the workflow |
| Continue | Proceeds immediately; an auto-approval message is created in the inbox | No |
In Continue mode, the message title is prefixed with Auto-approved: and the description is set to “This step was automatically approved.” — regardless of the title and description you configured on the step. The configured review data is still attached to the message.
Pending Reviews on Re-run
Starting a new run of an automation automatically closes any review messages from prior runs of the same automation that are still awaiting a decision. Their workflows are resumed as rejected so they don’t stay paused forever, and the messages are marked closed in the inbox. This also applies when running a composer — every automation referenced by the composer has its open reviews superseded before the new run starts.Review Data
The review data field lets you attach key-value pairs to the message. Use template variables to pull in data from previous steps — for example, showing the contract title and extracted royalty rate for a reviewer to verify. The data is displayed as a structured card on the message detail page. Any UUID values in the data are automatically resolved to their human-readable names — for example, a contract ID is shown as the contract title. When used inside a Loop step, each iteration creates its own review data entry with its own Approve and Reject buttons.Output
| Field | Type | Description |
|---|---|---|
data | object | The resolved review data |
message_id | string | ID of the created message |
Related Documentation
Messages
Where review messages appear in the organization.
Project Inbox
Project-level inbox where review messages also appear.