Skip to main content

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

1

Review Step Executes

The automation reaches the Review step and creates a message in the target project.
2

Message Appears in Inbox

The message shows up in the organization Messages page and the project’s Inbox, with the configured title, description, review data, and an Open button if a link was configured.
3

Team Reviews

A team member opens the message, reviews the key-value data, and can add replies or assign it to someone.
4

Approval or Rejection (Wait Mode)

If the review mode is Wait, the workflow is paused. The team member clicks Approve to resume the workflow or Reject to stop it. In Continue mode, the workflow proceeds immediately and an auto-approval message is created in the inbox.

​
Configuration

FieldDescription
Review ModeWait or Continue (see below)
TitleMessage title (supports template variables)
DescriptionMessage description (supports template variables)
LinkOptional 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 DataKey-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

ModeWorkflow BehaviorAction Required
WaitPauses at this step until a team member actsYes — click Approve to resume or Reject to stop the workflow
ContinueProceeds immediately; an auto-approval message is created in the inboxNo
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.

​
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.
In a loop, each iteration is independent — approving one entry immediately resumes that iteration’s workflow without waiting for the rest of the batch. You can review and approve or reject items one by one. In Continue mode inside a loop, each iteration still creates an auto-approval message in the inbox.

​
Output

FieldTypeDescription
dataobjectThe resolved review data
message_idstringID of the created message

Messages

Where review messages appear in the organization.

Project Inbox

Project-level inbox where review messages also appear.