Adobe Workfront Unified Review and Approvals modules

With the Adobe Workfront Unified Review and Approvals modules, you can get approval details, make a decision on an asset, add or delete approval participants, add or update approval stages, lock or unlock stages, and make custom API calls.

For information about Workfront unified review and approvals, see Unified review and approval overview in the Workfront documentation.

Access requirements

Expand to view access requirements for the functionality in this article.
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
Adobe Workfront package

Any Adobe Workfront Workflow package and any Adobe Workfront Automation and Integration package

Workfront Ultimate

Workfront Prime and Select packages, with an additional purchase of Workfront Fusion.

Adobe Workfront licenses

Standard

Work or higher

Product If your organization has a Select or Prime Workfront package that does not include Workfront Automation and Integration, your organization must purchase Adobe Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

Prerequisites

You must have the following to access Workfront Content and Approvals:

  • You must be on a version of Workfront that supports Adobe cloud storage. If your organization is not already on a supported version, contact your Adobe account representative.

Connect to Adobe Workfront Unified Review and Approvals

  1. In any Adobe Workfront Unified Review and Approvals module, click Add next to the Connection field.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto html-authored no-header
    Connection type Select Adobe Workfront Server-to-Server connection.
    Connection name Enter a name for the new connection.
    Instance name

    Enter the name of your instance, also known as your domain.

    Example: if your URL is https://example.my.workfront.com, enter example.

    Instance lane

    Enter the environment type that this connection will connect to.

    Example: if your URL is https://example.my.workfront.com, enter my.

    Client ID Enter your Workfront Client ID. This can be found in the OAuth2 Applications area of the Setup area in Workfront. Open the specific application you are connecting to to see the Client ID.
    Client Secret Enter your Workfront Client secret. This can be found in the OAuth2 Applications area of the Setup area in Workfront. If you do not have a Client Secret for your OAuth2 application in Workfront, you can generate another. For instructions, see the Workfront documentation.
    Scopes Enter any applicable scopes for this connection.
    Host prefix In most cases, this value should be origin.
  3. Click Continue to save the connection and return to the module.

    If you are not logged in to Workfront Unified Review and Approvals, you are directed to a login screen. After you log in, you can allow the connection.

Adobe Workfront Unified Review and Approvals modules

When you configure Workfront modules, Workfront Fusion displays the fields listed below. Along with these, additional Workfront fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.

Map toggle

Actions

Add or update participants

This action module adds or updates participants on the default stage on an approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to add or update a participant for.
Add participants to stages

For each stage that you want to add participants to, click Add item and enter the stage.

Then, for each participant that you want to add to the stage, click Add item and enter the participant details.

  • Participant ID

    Enter or map the ID of the participant.

  • Participant type

    Select whether the participant is a user or a tea.

  • Participant role

    Select whether the participant is an approver or a reviewer.

Bulk delete templates

This module deletes the specified approval templates.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Template IDs
For each template that you want to delete, click Add item and enter the template ID.

Create a template

This action module creates an approval template

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Name
Enter or map a name for the template.
Company ID
If you want to add a company scope to the template, enter or map the company ID.
Stages

For each stage that you want to add, click Add item and enter the stage data.

For specifics, see Stages fields in this article.

Shared with
For each user that you want to share the template with, click Add item and user ID and desired access level.

Create an approval

This action module creates an approval for a document on Adobe cloud storage, including stage data or a template.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to create an approval for.
Stages

For each stage that you want to add, click Add item and enter the stage data.

For specifics, see Stages fields in this article.

Template ID
Enter or map the ID of the template that you want to use for this approval.

Create stages

This action module creates an approval with the given stage data.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to create or update a stage for.
Stages

For each stage that you want to add, click Add item and enter the stage data.

For specifics, see Stages fields in this article.

Template ID
Enter or map the ID of the asset that you want to create stages for.

Delete a decision on a stage

This module removes the current user’s decision from the specified stage. The current user is the user whose credentials are used in the connection used in this module.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to delete a decision from.
Stage ID
Enter or map the ID of the stage that you want to delete.

Delete a stage

This action module deletes the specified stage from the approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to delete a stage from.
Stage ID
Enter or map the ID of the stage that you want to delete.

Delete a template

This module deletes the specified approval template.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Template ID
Enter or map the ID of the template that you want to delete.

Delete an approval

This action module deletes the approval for the given document.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to delete an approval from.

Delete decisions

This module removes the current user’s decision from the specified stage. The current user is the user whose credentials are used in the connection used in this module.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to delete a decision from.

Delete participants

This action module deletes participants from an approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to delete participants from.
Participant type
Select whether the participants is a user or a team.
Participant ID
Enter or map the ID of the participant.

Lock a stage

This action modules locks the specified approval stage and sets the stage to inactive.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to lock.
Stage ID
Enter or map the ID of the stage that you want to lock.

Make a decision

This action module applies a decision to an approval or approval stage.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to lock.
Decision
Select the decision to apply to the approval or stage.
Stage IDs
For each stage that you want to apply the decision to, click Add item and enter the stage ID.

Make a decision on a stage

This module applies a decision to the specified stage.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to make a decision on.
Stage ID
Enter or map the ID of the stage that you want to make a decision on.
Decision
Select the decision that you want to apply to this stage.

Remind a participant on a stage

This module sends a reminder to a specific participant on a specific stage.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to send a reminder for.
Stage ID
Enter or map the ID of the stage that you want to send a reminder for.
Participant ID
Enter or map the ID of the participant that you want to send a reminder to.

Remind participant

This module sends a reminder notification to the specified participant.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to send a reminder for.
Participant ID
Enter or map the ID of the participant that you want to remind.
Participant type
Enter or map the type of the participant that you want to remind.
Participant role
Enter or map the role of the participant that you want to remind.

Remind undecided participants

This module sends reminder notifications to all undecided participants on the specified approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to send a reminder for.

Remind undecided participants on a stage

This module sends reminder notifications to all undecided participants on a stage.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to send a reminder for.
Stage ID
Enter or map the ID of the stage that you want to send a reminder for.

Unlock a stage

This action modules unlocks the specified approval stage and sets the stage to active.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to unlock.
Stage ID
Enter or map the ID of the stage that you want to lock.

Update a stage

This action module updates fields on the specified stage.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to make a decision on.
Stage ID
Enter or map the ID of the stage that you want to make a decision on.
Stage name
Enter or map a name for the template.
Other fields

Enter data into the stage fields.

For more information, see Stages fields in this article.

Shared with
For each user that you want to share the template with, click Add item and user ID and desired access level.

Update a template

This module updates fields on the specified approval template.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Template ID
Enter or map a name for the template.
Name
Enter or map the ID of the template that you want to update.
Company ID
If you want to add a company scope to the template, enter or map the company ID.
Stages

For each stage that you want to add, click Add item and enter the stage data.

For specifics, see Stages fields in this article.

Shared with
For each user that you want to share the template with, click Add item and user ID and desired access level.

Update all stages

THis module replaces all stages on an existing approval with the given stage data. The document must be in an editable state.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the asset that you want to update stages for.
Stages

For each stage that you want to update, click Add item and enter the stage data.

For specifics, see Stages fields in this article.

Searches

Get a template

This module returns the specified approval template.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Template ID
Enter or map the ID of the document that you want to get suggested approval participants for.
Maximum number of returned templates
Enter or map the maximum number of templates you want the module to return during each scenario execution cycle.

Get approval details

This search module retrieves approval details for an asset.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document
Enter or map the ID of the asset that you want to retrieve approval details for.

Get multiple approvals

This module retrieves details of approvals for a list of documents of a specific type.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document IDs
For each document that you want to retrieve approval details for, click Add item and enter the document ID.
Maximum number of returned results
Enter or map the maximum number of results you want the module to return during each scenario execution cycle.

Get suggested approvals

This module returns suggested approval payloads from prior document versions.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to get suggested approvals for.
Maximum number of returned approvals
Enter or map the maximum number of approvals you want the module to return during each scenario execution cycle.

Get suggested participants

This module returns participant suggestions from the approval for the previous document approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Document ID
Enter or map the ID of the document that you want to get suggested approval participants for.
Maximum number of returned participants
Enter or map the maximum number of participants you want the module to return during each scenario execution cycle.

List Bots

This module returns a paginated list of bot accounts.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Page
Enter or map the page of results that you want to return.
Maximum number of returned results
Enter or map the maximum number of results you want the module to return during each scenario execution cycle.

List Templates

This module returns a list of all approval templates available to the current user. The current user is the user whose credentials are used in the connection used in this module.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.

Search AI brand reviews

This module returns AI brand review results that were produced for a document version as part of an approval.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Bot user ID
Enter or map the user ID of the bot that you want to search reviews for.
Parent document ID
Enter or map the ID of the parent document that you want to search reviews for.
Document version ID
Enter or map the ID of the asset that you want to send a reminder for.
Stage ID
Enter or map a stage ID to limit results to a specific stage of the approval.
Page
Enter or map a page number to limit results to that page.
Maximum number of returned reviews
Enter or map the maximum number of reviews you want the module to return during each scenario execution cycle.

Other

Make a custom API call

This module makes a custom API call to the Adobe Workfront Unified Review and Approvals API.

Connection
For instructions on creating a connection to Adobe Workfront Unified Review and Approvals, see Connect to Adobe Workfront Unified Review and Approvals in this article.
Relative path
Enter a path relative to https://workfront.adobe.io. For example, /unified-approvals/public/api/v1/approvals/<ASSET_TYPE>/<ASSET_ID>
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Query String
For each key/value pair that you want to add to the query string, click Add item and enter the key and value.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Stages fields

The following fields are available when configuring stages. Not all fields may be available for all modules.

Stage name
Enter or map a name for the stage.
Deadline date
If the deadline is a specific date, enter or map the date.
Deadline business days
If the deadline is after a specific number of business days, enter or map the number of days.
Deadline time
If the deadline is a specific time, enter or map the time.
Participants

For each participant that you want to add to the stage, click Add item and enter the participant details.

  • Participant ID

    Enter or map the ID of the participant.

  • Participant type

    Select whether the participant is a user or a team.

  • Participant role

    Select whether the participant is an approver or a reviewer.

Auto lock enabled
Specify whether you want to auto-lock the stage.
Decision rules
Select whether you want to require only one decision for the stage.
Parent IDs / Parent stage IDs
For each parent stage that you want to add to the stage, click Add item and enter the Parent ID.
Triggers

To configure a trigger for this approval stage, click Add item and enter the trigger details.

  • Type

    Select Activation

  • When

    Select whether to trigger the stage when the approval is created or when another stage is complete.

  • Stages

    For each stage that you want to add to the trigger, click Add item and enter or map the stage ID.

  • Decisions

    For each decision that you want to add to the trigger, click Add item and enter or map the decision.

Custom message
Enter or map a custom message for the stage.
recommendation-more-help
workfront-fusion-help-workfront-fusion