DocumentationAdobe Workfront Fusion

Adobe Workfront Planning modules

Last update: May 6, 2026

With the Adobe Workfront Planning modules, you can trigger a scenario when events occur in Workfront Planning. You can also create, read, update, and delete records, or perform a custom API call to your Adobe Workfront Planning account.

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 Planning:

  • A new Workfront package and license. Workfront Planning is not available for legacy Workfront packages or licenses.
  • A Workfront Planning package.
  • Your organization’s instance of Workfront must be onboarded to the Adobe Unified Experience.

Adobe Workfront Planning API information

The Adobe Workfront Planning connector uses the following:

Base URL
code language-none 
https://{{connection.host}}/maestro/api/{{common.maestroApiVersion}}/
API tag
v1.13.7

Connect Workfront Planning to Workfront Fusion

The Workfront Planning connector uses OAuth 2.0 to connect to Workfront Planning.

You can create a connection to your Workfront Planning account directly from inside a Workfront Planning Fusion module.

Connect to Workfront Planning using Client ID and Client secret

  1. In any Adobe Workfront Planning 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 layout-auto html-authored no-header
    Connection type Select Adobe Workfront auth connection.
    Connection name Enter a name for the new connection.
    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.
    Authentication URL

    This can remain the default value, or you can enter the URL of your Workfront instance, followed by /integrations/oauth2.

    Example: https://mydomain.my.workfront.com/integrations/oauth2
    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 Planning, you are directed to a login screen. After you log in, you can allow the connection.

NOTE
  • OAuth 2.0 connections to the Workfront API no longer rely on API keys.
  • To create a connection to a Workfront Sandbox environment, you must create an OAuth2 application in that environment, and then use the Client ID and Client Secret generated by that application in your connection.

Connect to Workfront Planning using a Server-to-Server connection

  1. In any Adobe Workfront Planning 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 Planning, you are directed to a login screen. After you log in, you can allow the connection.

NOTE
  • OAuth 2.0 connections to the Workfront API no longer rely on API keys.
  • To create a connection to a Workfront Sandbox environment, you must create an OAuth2 application in that environment, and then use the Client ID and Client Secret generated by that application in your connection.

Adobe Workfront Planning Version 2 modules and their fields

IMPORTANT
The modules in this section belong to the Workfront Planning V2 connector.
For modules in the Workfront Planning V1 connector, see Adobe Workfront Planning Version 1 modules and their fields.

When you configure Workfront Planning 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.

Workspaces (V2)

Create a workspace (V2)

This action module creates a new workspace in Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace name
Enter or map a name for the new workspace.
Description
Enter or map a description for the new workspace/td>
Color
Select the color that you want to use to represent the new record type
Icon
Map the icon that you want to use for this record type.
Owner
Enter or map the Adobe IMS user ID of the user that you want to own the workspace.

Delete a workspace (V2)

This action module deletes a single workspace, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace ID
Enter or map the ID of the workspace that you want to delete.

Get all workspaces (V2)

This module retrieves a list of all workspaces.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Maximum number of returned workspaces
Enter or map the maximum number of workspaces that the module will return during one execution cycle.

Get a workspace (V2)

This module retrieves a workspace by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace ID
Enter or map the ID of the workspace that you want to retrieve.

Update a workspace (V2)

This action module updates a new workspace in Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that you want to update.
Workspace name
Enter or map a name for the new workspace.
Description
Enter or map a description for the new workspace/td>
Color
Select the color that you want to use to represent the new record type
Icon
Map the icon that you want to use for this record type.
Owner
Enter or map the Adobe IMS user ID of the user that you want to own the workspace.
Record type sections
For each record type section you want to add to this workspace, click Add item and enter the section's name, record type IDs, and whether you want to overwrite existing record type IDs.
Record type sections > Overwrite
Select whether to replace existing sections with the ones from the module. If no, sections from the module are added to the existing list of sections.

Record types (V2)

Create a record type (V2)

This action module creates a new record type in the selected workspace.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to create a record type.
Display name
Enter or map a name for the new record type.
Description
Enter or map a description for the new record type.
Icon
Map the icon that you want to use for this record type.
Color
Select the color that you want to use to represent the new record type
Source record type
If you are using another record type to copy as a starting point, select that record type.

Delete a record type (V2)

This action module deletes a single record type, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record type ID
Enter or map the ID of the record type that you want to delete.

Get global record types (V2)

This module retrieves a list of record types in an Adobe Workfront Planning account.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select a workspace. The module will return global record types that are available to add to this workspace.
Maximum number of returned record types
Enter or map the maximum number of record types that the module will return during one execution cycle.

Get a record type (V2)

This module retrieves a record type by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record type ID
Enter or map the ID of the record type that you want to retrieve.

Get record types (V2)

This module retrieves a list of record types available in a given workspace.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that you want to retrieve record types for.
Maximum number of returned record types
Enter or map the maximum number of record types that the module will return during one execution cycle.

Update a record type (V2)

This module updates a record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to update a record type.
Record type
Select the workspace where you want to update a record type.
Display name
Enter or map a name for the record type.
Description
Enter or map a description for the record type.
Primary field ID
Enter or map the ID of the field that is used as the title of the record type.
Icon
Map the icon that you want to use for this record type.
Color
Select the color that you want to use to represent the new record type
Linkable with Workspace IDs
For each workspace that you want this record type to be able to link to, click Add item and enter the workspace's ID.
Linkable with Workspace IDs > Overwrite
Select whether to replace existing workspaces with the ones from the module. If no, workspaces from the module are added to the existing list of workspaces.
Authorized to create dynamic record type
For each subject authorized to create dynamic record types from this record type, click Add item and enter the subject's type and ID.
Authorized to create dynamic record type > Overwrite
Select whether to replace existing subjects with the ones from the module. If no, subjects from the module are added to the existing list of subjects.

Records (V2)

Create a record (V2)

This action creates a single record in Workfront Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to create a record.
Record type
Select the type of record that you want to create.
Other fields
Enter the values that you want the new record to have. These fields are based on the record type you selected, and are unique to your Workfront Planning organization.

Delete a record (V2)

This action module deletes a single record, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record ID
Enter or map the ID of the record that you want to delete.

Get a record (V2)

This action module retrieves a record, specified by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace ID
Enter or map the ID of the record that you want to retrieve.

Get records by record type (V2)

This module retrieves a list of all records of the given record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the records you want to retrieve.
Record type
Select the type of record that you want to return.
Maximum number of returned records
Enter or map the maximum number of records that the module will return during one execution cycle.

Move records (V2)

This module reorders one or more records within a record type by specifying where to place them.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the records you want to move.
Record type
Select the type of record that you want to move.
Workspace
Select the workspace that contains the records you want to move.
Workspace
Select the workspace that contains the records you want to move.

Search records (V2)

Return records based on criteria you specify

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the records you want to retrieve.
Record type
Select the record type that contains the records you want to retrieve.
Other fields
For each field that you want to filter by, enter the operator and value for that field. These fields are based on the record type you selected, and are unique to your Workfront Planning organization.

Update a record (V2)

This module updates the specified record.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the record that you want to update.
Record type ID
Select the type of record that you want to update.
Record ID
Enter or map the ID of the record that you want to update.
Other fields
Enter values for other fields. Available fields depend on the selected record.

Fields (V2)

Create a field (V2)

This action module creates a new field on the specified record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to create a field.
Record type
Select the record type that you want to create a field for.
Display name
Enter or map a name for the new field.
Description
Enter or map a description for the new field.
Field type
Select the data type for the field.
Other fields
Other fields specific to the selected field type may be available. Fill in values for these fields.

Delete a field (V2)

This action module deletes a single field, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Field ID
Enter or map the ID of the field that you want to delete.

Get a field (V2)

This module retrieves a field by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Field ID
Enter or map the ID of the field that you want to retrieve.

Get fields by record type (V2)

This module retrieves a list of fields for a specific record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the fields you want to return.
Record type
Select the record type that you want to return fields for.
Maximum number of returned fields
Enter or map the maximum number of fields that the module will return during one execution cycle.

Update a field (V2)

This module partially updates a field by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Select the resource type that contains the field you want to update.
Field ID
Select the field that you want to update.
Display name
Enter or map a name for the field.
Description
Enter or map a description for the field.
Other parameters
Enter values for other field parameters. Available parameters depend on the selected field.

Views (V2)

Create a view (V2)

This action module creates a new view for the selected record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to create a view.
Record type
Select the record type that you want to create a view for.
View name
Enter or map a name for the new view.
View type
Select whether the new view is a table, timeline, or calendar view.
Start date field
If the view will be a timeline or calendar view, select the field that the view will use to place the record on the timeline.
End date field.
If the view will be a timeline or calendar view, select the field that the view will use to determine the end date on the timeline.

Delete a view (V2)

This action module deletes a single view, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
View ID
Enter or map the ID of the view that you want to delete.

Get a view (V2)

This module retrieves a view by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
View ID
Enter or map the ID of the view that you want to retrieve.

Get views by record type (V2)

This module retrieves a list of views for the specific record type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace that contains the views you want to retrieve.
Record type
Select the record type that contains the views you want to retrieve.
Maximum number of returned views
Enter or map the maximum number of views that the module will return during one execution cycle.

Update a view (V2)

This action module updates the specified view.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select the workspace where you want to update a view.
Record type
Select the record type that you want to update a view for.
View ID
Select the view that you want to update.
View name
Enter or map a name for the new view.

Permissions (V2)

Dismiss access requests (V2)

This action module dismisses one or more access requests, specified by ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Enter or map the ID of the Workspace that you want to delete.
Resource ID
Enter or map the ID of the resource that you want to dismiss access requests for.
Request IDs
For each access request that you want to dismiss, click Add item and enter the request ID.

Get all members and their roles for a resource (V2)

This module lists all users, groups, and teams that have an explicit sharing relation on the resource. The credentials used in the connection for this module must have Manage permission on the resource.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Select the type of resource that you want to retrieve information for.
Resource ID
Enter or map the ID of the resource that you want to retrieve information for.

Get the current user’s effective permissions on a resource (V2)

This module returns the current user’s view, edit, delete, and add permissions for a given resource.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Select the resource type that you want to retrieve permissions for.
Resource ID
Enter or map the ID of the resource that you want to retrieve permissions for.

List pending access requests for a resource (V2)

This module returns all pending access requests for the given resource.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Select the type of resource that you want to retrieve information for.
Resource ID
Enter or map the ID of the resource that you want to retrieve information for.

Request access to a resource (V2)

This module creates or updates an access request for the current user on the given resource.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Resource type
Select the type of resource that you want to create or update an access request for.
Resource ID
Enter or map the ID of the resource that you want to create or update an access request for.
Message
Enter or map the text of a message that you want to include with the access request.

Other (V2)

Get auth ID from Workfront ID (V2)

This module takes a Workfront user ID and returns the matching authorization ID that Planning uses.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workfront User ID
Enter or map the Workfront ID of the user that you want to retrieve an authorization ID for.

Make a custom API call (V2)<table

This module make a custom call to the Workfront Planning API.

Connection
For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
URL
Enter a path relative to https://<WORKFRONT_DOMAIN>/maestro/api/..
API Version
Select the version of the Workfront API that you want the module to use.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object. This determines the content type of the request.

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

Query String

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

For example: {"name":"something-urgent"}

Tip: We recommend that you send information through the JSON body rather than as query parameters.

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.

Watch Events (V2)

This trigger module starts a scenario when a record, record type, or workspace is created, updated, or deleted in Workfront Planning.

IMPORTANT
You can edit this module later, which will edit the webhook.
Consider the following when updating a webhook:
  • The edited webhook is treated by Workfront event subscriptions as a new subscription. Event subscription history is not preserved for the previous webhook configuration, because that is considered a separate event subscription.
  • The switch from old to new event subscription may not be perfectly synchronized. It is therefore possible to receive an event twice (if the new subscription begins running before the old one stops) or to miss an event (if the old subscription stops before the new one begins running).
For more information on editing webhooks, see Edit webhooks.
Webhook
Select the webhook that you want to use, or click Add to create a new one.
Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Object type
Select whether you want to watch records, record types, or workspaces.
Objects to watch
Select whether you want to watch new records, updated records, both new and updated records, or deleted records.
Configuration type

Select whether you want simple configuration or advanced configuration.

For more information on advanced configuration, see Example of advanced logic in the watch Events module in this article.

State

Select whether you want to watch the old state or the new state.

  • New state

    Trigger a scenario when the record changes to a given value.

  • Old state

    Trigger a scenario when the record changes from a given value.

Workspace
If watching records, select the Workspace you want to watch for records.
Record type
If watching records, select the type of record you want to watch for.
Events filters

You can set filters to watch for only records that meet criteria you select.

For each filter, enter the field you want the filter to evaluate, the operator, and the value that you want the filter to allow. You can use more than one filter by adding AND rules.

Note: You cannot edit filters in existing Workfront webhooks. To set up different filters for Workfront event subscriptions, remove the current webhook and create a new one.

For more information on event filters, see Event subscription filters in the Workfront > Watch Events modules in the Workfront modules article.

Objects to watch
Select whether you want to watch for new. updated, new and updated, or deleted records.
Exclude updates made by this connection
Enable this option to prevent the scenario from triggering when a change is made by the connection used by this module. This prevents another instance of the scenario being triggered if this scenario performs a triggering action.

For an example of using advanced logic on this module, see Example of advanced logic in the watch Events module.

Adobe Workfront Planning Version 1 modules and their fields

IMPORTANT
The modules in this section belong to the Workfront Planning V1 connector.
For modules in the Workfront Planning V2 connector, see Adobe Workfront Planning Version 2 modules and their fields.

When you configure Workfront Planning 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

Triggers

Watch Events

This trigger module starts a scenario when a record, record type, or workspace is created, updated, or deleted in Workfront Planning.

IMPORTANT
You can edit this module later, which will edit the webhook.
Consider the following when updating a webhook:
  • The edited webhook is treated by Workfront event subscriptions as a new subscription. Event subscription history is not preserved for the previous webhook configuration, because that is considered a separate event subscription.
  • The switch from old to new event subscription may not be perfectly synchronized. It is therefore possible to receive an event twice (if the new subscription begins running before the old one stops) or to miss an event (if the old subscription stops before the new one begins running).
For more information on editing webhooks, see Edit webhooks.
Webhook
Select the webhook that you want to use, or click Add to create a new one.
Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Object type
Select whether you want to watch records, record types, or workspaces.
State

Select whether you want to watch the old state or the new state.

  • New state

    Trigger a scenario when the record changes to a given value.

  • Old state

    Trigger a scenario when the record changes from a given value.

Workspace
If watching records, select the Workspace you want to watch for records.
Record type
If watching records, select the type of record you want to watch for.
Events filters

You can set filters to watch for only records that meet criteria you select.

For each filter, enter the field you want the filter to evaluate, the operator, and the value that you want the filter to allow. You can use more than one filter by adding AND rules.

Note: You cannot edit filters in existing Workfront webhooks. To set up different filters for Workfront event subscriptions, remove the current webhook and create a new one.

For more information on event filters, see Event subscription filters in the Workfront > Watch Events modules in the Workfront modules article.

Objects to watch
Select whether you want to watch for new. updated, new and updated, or deleted records.
Exclude updates made by this connection
Enable this option to prevent the scenario from triggering when a change is made by the connection used by this module. This prevents another instance of the scenario being triggered if this scenario performs a triggering action.

For an example of using advanced logic on this module, see Example of advanced logic in the watch Events module.

Actions

Delete a record type

This action module deletes a single record type in Workfront Planning by its ID.

WARNING
Deleting a record type in Workfront Planning also deletes all records in the record type table.
Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record type ID
Enter or map the ID of the record type you want to delete.

Make a custom API call

This module makes a custom API call to the Adobe Workfront Planning API.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
URL
Enter a path relative to https://(YOUR_WORKFRONT_DOMAIN)/maestro/api/
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.

Searches

Search records

This action module retrieves a list of records based on criteria you specify.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Enter or map the Workspace that contains the records that you want to search.
Record type
Select the record type that you want to search.
Record Fields
For each field that you want to use in your search, locate that field, select the operator, and enter or map the value that you want to search for. Field are available based on the record type selected.
Condition for filters

Select the condition for your filters:

  • AND

    The module returns records that meet all of the field values you selected.

  • OR

    The module returns records that meet any of the field values you selected.

Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Uncategorized

Create a record

This action creates a single record in Workfront Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record type ID
Enter or map the type of record you want to create. Available record types are based on your Workfront Planning account.
Other fields
Enter the values that you want the new record to have. These fields are based on the record type you selected.

Delete a record

This action module deletes the specified record in Workfront Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record ID
Enter or map the ID of the record you want to delete.

Get a record

This action module retrieves a single record from Adobe Workfront Planning, specified by its ID.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record ID
Enter or map the ID of the record you want to retrieve.

Get records by record type

This action module retrieves all records of the specified type.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select or map the workspace that contains the records you want to retrieve.
Record type
Select the type of record that you want to retrieve.

Get record types

This action module retrieves a list of record types in an Adobe Workfront Planning account.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Workspace
Select or map the workspace that contains the record types you want to retrieve.

Update record

This action updates a single record in Workfront Planning.

Connection
For instructions on creating a connection to Adobe Workfront Planning, see Create a connection to Adobe Workfront Planning in this article.
Record ID
Enter or map the type of record you want to update . Available record types are based on your Workfront Planning account.
Other fields
Enter the new values that you want the record to have. These fields are based on the record type you selected.

Use JSONata for readable record-types breakdown

The following JSONata expression creates a human-readable output of the Planning query that gives you the record-types breakdown. This makes the record type name, field names, and field option names (where applicable) human readable by a name, and keeps the rest of the structure intact.

(
    $s0 := ({"data":$ ~> | fields | {"options":(options){name:$}} |});
    $s1 := ({"data":$s0.data ~> | **.fields | {"options_name":(options.*){displayName:$}} | });
    $s2 := $s1 ~> | data | {"fields":(fields){displayName:$}} |;
    $s2.data{displayName:$}
)

For information on using JSONata modules, see JSONata modules.

Example of advanced logic in the watch Events module

This is an example of the format that advanced logic takes when using the Workfront Planning > Watch Events module.

[
  {
    "fieldName": "recordTypeId",
    "fieldValue": "Rt68c886502d4b5554ee80896b",
    "comparison": "eq",
    "state": "newState"
  },
  {
    "fieldName": "data",
    "fieldValue": {
      "F68c886502d4b5554ee808975": "planning"
    },
    "comparison": "eq",
    "state": "newState"
  },
  {
    "fieldName": "data",
    "fieldValue": {
      "F68c886502d4b5554ee808975": "active"
    },
    "comparison": "eq",
    "state": "newState"
  }
]

Consider the following when using advanced logic in the Watch Event module:

  • The first "fieldvalue": entry is the Planning Record Type ID pulled from the URL. In this example, the Planning Record Type ID is Rt68c886502d4b5554ee80896b.
  • Planning data is returned inside an array called data , which appears in this example as "fieldName": "data".
  • Planning fieldNames are returned as IDs that start with F.
  • Because this example is evaluating against an OR filter connector, it has two entries for the same field (F68c886502d4b5554eec808975). The two drop down options that the module is filtering against are "planning" and "active".
recommendation-more-help
workfront-fusion-help-workfront-fusion