Adobe Workfront modules

You can use the Adobe Workfront Fusion Adobe Workfront connector to automate your processes within Workfront. If you have a Workfront Fusion for Work Automation and Integration license, you can also use it to connect to third-party apps and services.

The Workfront connector does not count against the number of active apps available to your organization. All scenarios, even if they use only the Workfront app, do count against your organization’s total scenario count.

For more information on your organization’s available apps and scenarios, see Organizations in Adobe Workfront Fusion organizations and teams.

If you need instructions on creating a scenario, see Create a scenario in Adobe Workfront Fusion. For information about modules, see Modules in Adobe Workfront Fusion.

Access requirements

You must have the following access to use the functionality in this article:

Adobe Workfront plan*

Pro or higher
Adobe Workfront license*

Plan, Work
Adobe Workfront Fusion license**

Workfront Fusion for Work Automation and Integration

Workfront Fusion for Work Automation
Product Your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Connect Workfront to Workfront Fusion

The Workfront connector uses OAuth 2.0 to connect to Workfront.

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

  1. In any Workfront app module, click Add next to the Connection box.

  2. Enter the name of your instance into the URL. Example: https://<your instance>.my.workfront.com.

  3. Click Next.

  4. Click SAML log in to create the connection and go back to the module.

    Or

    Enter your Username and Password, then click Log in to create the connection and go back to the module.

    NOTE

    • If you do not see a SAML log in button, your organization has not enabled Single Sign-On (SSO). You can log in with your Username and Password.

      For more information on SSO, see Overview of single sign-on in Adobe Workfront

    • OAuth 2.0 connections to the Workfront API no longer rely on API keys.

Workfront modules and their fields

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 in Adobe Workfront Fusion.

Triggers

 Watch Events

This trigger module executes a scenario in real time when objects of a specific type are added, updated, or deleted in Workfront

The module returns any standard fields associated with the record, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

  1. Click Add to the right of the Webhook box.

  2. Configure the webhook in the Add a hook box that displays.

    When you are configuring this module, the following fields display.

    Webhook name (Optional) Type a new name for the webhook
    Connection

    For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
    Record Type Select the type of Workfront record that you want the module to watch.
    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.

      For example, if the state is set to New State and the filter is set to Status Equals In Progress, the webhook triggers a scenario when the Status changes to In Progress, regardless of what the status was before.

    • Old state

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

      For example, if the state is set to Old State and the filter is set to Status Equals In Progress, the webhook triggers a scenario when a Status that is currently In Progress changes to another status.

    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 this article.
    Exclude events made by this connection Enable this option to exclude events created or updated using the same connector that this trigger module uses. This can prevent situations where a scenario might trigger itself, causing it to repeat in an endless loop.
    Record Origin

    Choose whether you want the scenario to watch New Records Only, Updated Records Only, New and Updated Records, or Deleted Records Only.

    Note: If you choose New and Updated Records, the webhook creation creates 2 event subscriptions (for the same webhook address).

After the webhook is created, you can view the address of the endpoint that events are sent to.

For more information, see the section Examples of Event Payloads in the Workfront Help article Event Subscription API.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Watch Field

This trigger module executes a scenario when a field that you specify is updated. The module returns both the old and the new value of the field you specify. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of Workfront record that you want the module to watch.

For example, select Task if you want to start executing the scenario each time a record field is updated in a task.
Field Select the field that you want the module to watch for updates. These fields reflect the fields that your Workfront administrator has set up for tracking.
Outputs Select the information you want included in the output bundle for this module.
Limit

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

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Watch Record

This trigger module executes a scenario when objects of a specific type are added, updated, or both. The module returns all standard fields associated with the record or records, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario. In the output, the module indicates whether each record is new or updated.

Records that were both added and updated in the given time period are returned as new records.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Filter

Choose whether you want the scenario to watch New Records Only, Updated Records Only, or New and Updated Records.
Record Type

(Displays after you choose a Filter.) Select the type of Workfront record that you want the module to watch.

For example, if you want to start the scenario each time a new Project is created, select Project
Outputs

Select the information you want included in the output bundle for this module.
Optional Filter

(Advanced) Type an API code string to define any additional parameters or code that will refine your criteria.

Limit

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

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

Actions

 Convert object

This action module makes one of the following conversions:

  • Convert Issue to Project
  • Convert Issue to Task
  • Convert Task to Project
Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Object type

Select the type of object that you want to convert. This is the type that the object has before the conversion.
Convert to Select the object that you want to convert it to. This is the type that the object has after the conversion.
<Object> ID

Enter the object's ID.

Note: When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.
Template ID

If you are converting to a project, select the Template ID that you want to use for the project.

Note: When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.
Custom forms Select any custom forms that you want to add to the newly converted object, then enter values for the custom form's fields.
Options

Enable any options you want when converting the object. Options are available depending on which object you are converting to or from.
 Create a record (attaching custom forms)

This action module creates an object, such as a project, task, or issue in Workfront, and allows you to add a custom form to the new object. The module allows you to select which of the object’s fields are available in the module.

You specify the ID of the record.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

You could use this module, for example, to create a task in Workfront when a client adds a new row in a Google Sheets list of tasks that need to be done.

When you are configuring this module, the following fields display.

Make sure you provide the minimum number of input fields. For example, if you want to create an issue, you need to provide a valid parent project ID in the Project ID field to indicate where the issue should live in Workfront. You can use the mapping panel to map this information from another module in your scenario, or you can enter it manually by typing in the name and then selecting it from the list.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of Workfront record that you want the module to create.

For example, if you want to create a Project, select Project from the dropdown list and then make sure that you have access to data (from previous modules in the scenario) that will populate the project.
Select fields to map

Select the fields that you want available for data input. This allows you to use these fields without having to scroll through the ones you don't need.

For fields in custom forms, use the Attach Custom Form field.
Attach Custom Form Select any custom forms that you want to add to the new object, then enter values for those fields.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

NOTE

  • When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

  • When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

    For more information on rich text in updates, see Add an update to a work item in Update work.

 Create Record

This action module creates an object, such as a project, task, or issue in Workfront. The module allows you to select which of the object’s fields are available in the module.

You specify the ID of the record.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

You could use this module, for example, to create a task in Workfront when a client adds a new row in a Google Sheets list of tasks that need to be done.

When you are configuring this module, the following fields display.

Make sure you provide the minimum number of input fields. For example, if you want to create an issue, you need to provide a valid parent project ID in the Project ID field to indicate where the issue should live in Workfront. You can use the mapping panel to map this information from another module in your scenario, or you can enter it manually by typing in the name and then selecting it from the list.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of Workfront record that you want the module to create.

For example, if you want to create a Project, select Project from the dropdown list and then make sure that you have access to data (from previous modules in the scenario) that will populate the project.
Select fields to map Select the fields that you want available for data input. This allows you to use these fields without having to scroll through the ones you don't need.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

NOTE

  • When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

  • When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

    For more information on rich text in updates, see Add an update to a work item in Update work.

 Custom API Call

This action module lets you make a custom authenticated call to the Workfront API. This way, you can create a data flow automation that can’t be accomplished by the other Workfront modules.

The module returns the following information:

  • Status Code (number): This indicates the success or failure of your HTTP request. These are standard codes that you can look up on the internet.

  • Headers (object): A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, so some might not be useful to you.

    The response headers depend on the HTTP request you chose when configuring the module.

  • Body (object): Depending on the HTTP request you chose when configuring the module, you may receive some data back. That data, such as the data from a GET request, is contained in this object.

You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

td>

Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in Adobe Workfront Fusion.

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>/attask/api/<API_VERSION>/.
API Version Select the version of the Workfront API that you want the module to use.
Method
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"}

Note: If you're getting errors and it's difficult to determine their origin, consider modifying headers based on the Workfront documentation. If your Custom API Call returns a 422 HTTP Request Error, try using a "Content-Type":"text/plain" header.
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.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Delete Record

This action module deletes an object, such as a project, task, or issue in Workfront.

You specify the ID of the record.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Force delete Enable this option to ensure that the record is deleted, even if the Workfront UI would request confirmation of the deletion.
ID

Enter the unique Workfront ID of the record that you want the module to delete.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e
Record Type Select the type of Workfront record that you want the module to delete.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Download Document

This action module downloads a document from Workfront.

You specify the ID of the record.

The module returns the document’s content, filename, file extension, and file size. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Document ID

Map or manually enter the unique Workfront ID of the document that you want the module to download.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Misc Action

This action module lets you perform actions against the API.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of Workfront record that you want the module to interact with.
Action

Select the action you want the module to perform.

You may need to fill out additional fields, depending on the Record Type and Action you choose. Some combinations of these two settings may require only a record ID, while others (such as Project for the Record Type and Attach Template for the Action) require additional information (such as an Object ID and a Template ID).

For details about individual fields, see the Workfront developer documentation.

  1. Select the record type from the left navigation on the Workfront developer documentation page. The following types have their own pages:

    • Projects

    • Tasks

    • Issues

    • Users

    • Documents

    For all other record types, select Other objects and endpoints, and locate the record type on the alphabetically sorted pages.

  2. On the page of the appropriate record type, search (Ctrl-F or Cmd-F) for the action.

  3. View descriptions for available fields under the selected action.

Note:

When creating a proof through the Workfront Misc Action module, best practice is to create a proof without any advanced options, then update the proof using the Workfront Proof SOAP API.

For more information on creating a proof with the Workfront API (which this module uses), see Add advanced proofing options when creating a proof through the Adobe Workfront API
ID Enter or map the unique Workfront ID of the record that you want the module to interact with.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Read a Record

This action module retrieves data from a single record.

You specify the ID of the record. You can also specify which related records you want the module to read.

For example, if the record that the module is reading is a project, you can specify that you want the project’s tasks read.

The module returns an array of data from the standard fields for the output you specified.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type Choose the Workfront object type that you want the module to read.
Outputs

Select the information you want included in the output bundle for this module.
References Select any reference fields that you want to include in the output.
Collections Select any reference fields that you want to include in the output.
ID

Enter the unique Workfront ID of the record that you want the module to read.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

 Update Record

This action module updates an object, such as a project, task, or issue. The module allows you to select which of the object’s fields are available in the module.

You specify the ID of the record.

The module returns the ID of the object and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
ID

Enter the unique Workfront ID of the record that you want the module to update.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e
Record Type

Select the type of Workfront record that you want the module to update.
Select fields to map Select the fields that you want available for data input. This allows you to use these fields without having to scroll through the ones you don't need.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

NOTE

  • When entering the ID of an object, you can begin typing the name of the object, then select it from the list. The module then enters the appropriate ID into the field.

  • When entering the text for a custom field or a Note object (Comment or reply), you can use HTML tags in the Note Text field to create rich text, such as bold or italic text.

    For more information on rich text in updates, see Add an update to a work item in Update work.

 Upload Document

This action module uploads a document to a Workfront object, such as a project, task, or issue.

You specify the location for the document, the file you want to upload, and an optional new name for the file.

The module returns the ID of the document and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Related Record ID Enter the unique Workfront ID of the record to which you want to upload the document.
Related Record Type Select the type of Workfront record where you want the module to upload the document.
Source file

Select a source file from a previous module, or map the source file's name and data.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

Searches

 Read Related Records

This search module reads records that match the search query you specify, in a particular parent object.

You specify which fields you want included in the output. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of the parent record (Workfront object) whose associated records you want to read.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module in this article.
Parent Record ID

Enter or map the ID of the parent record whose associated records you want to read.

To get the ID, open the Workfront object in your browser and copy the text at the end of the URL after "ID=." For example: https://my.workfront.com/project/view?ID=5e43010c03286a2a555e1d0a75d6a86e
Collections Select or map the type of child record that you want the module to read.
Outputs

Select the information you want included in the output bundle for this module.
 Search

This search module looks for records in an object in Workfront that match the search query you specify.

You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Connection

For instructions about connecting your Workfront app to Workfront Fusion, see Connect Workfront to Workfront Fusion in this article.
Record Type

Select the type of Workfront record that you want the module to search for.
Result Set Select an option to specify whether you want the module to get the first result that matches your search criteria or all the results that match it.
Maximal

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

Enter the field that you want to search by, the operator you want to use in your query, and the value that you are searching for in the field.

Note: Do not use username in your search criteria. Including username in an API query to Workfront logs the user into Workfront, and the search will not be successful.

Note: In and NotInwork with arrays. The inputs should be in array format.
Outputs

Select the fields that you want to include in the output for this module.
References Select any reference fields that you want to include in the search.
Collections Select any collections that you want to add to the search.

See a list of the Workfront object types for which you can use this module in Workfront object types available for each Workfront module.

Workfront object types available for each Workfront module

 Object types available for each Workfront trigger module
Watch Record Watch Field Watch Events
Approval Process ✓
Assignment ✓ ✓
Baseline ✓
Billing Record ✓
Billing Rate ✓
Company ✓ ✓ ✓
Dashboard ✓
Document ✓ ✓ ✓
Document Folder ✓ ✓
Document Request ✓
Document Version ✓ ✓
Expense ✓ ✓ ✓
Expense Type
Group ✓ ✓
Hour ✓ ✓
Hour Type ✓
Issue ✓ ✓ ✓
Iteration ✓ ✓
Job Role ✓ ✓
Journal Entry ✓
Milestone ✓
Milestone Path ✓ ✓
Note ✓ ✓ ✓
Note Tag ✓
Portfolio ✓ ✓ ✓
Program ✓ ✓ ✓
Project ✓ ✓ ✓
Project User ✓
Reserved Time* ✓
Report ✓
Risk
Risk Type
Step Approver ✓
Task ✓ ✓ ✓
Team ✓
Template ✓ ✓ ✓
Template Task ✓ ✓
Timesheet ✓ ✓ ✓
User ✓ ✓ ✓
Update
 Object types available for each Workfront action module
NOTE

The Download Document module is not included in this table because Workfront object types are not part of its configuration.

Create a record Update a record Delete a record Upload Document Read a record Custom API Call Misc Action
Approval Process ✓ ✓ ✓ ✓ ✓ ✓ ✓
Assignment ✓ ✓ ✓ ✓ ✓ ✓
Billing Record ✓ ✓ ✓ ✓
Billing Rate ✓ ✓ ✓ ✓ ✓
Company ✓ ✓ ✓ ✓ ✓ ✓ ✓
Document ✓ ✓ ✓ ✓ ✓ ✓ ✓
Document Folder ✓ ✓ ✓ ✓ ✓ ✓ ✓
Document Version ✓ ✓ ✓ ✓ ✓ ✓ ✓
Expense ✓ ✓ ✓ ✓ ✓ ✓ ✓
Expense Type ✓ ✓ ✓ ✓
Group ✓ ✓ ✓ ✓ ✓ ✓ ✓
Hour ✓ ✓ ✓ ✓ ✓
Hour Type ✓ ✓ ✓ ✓
Issue ✓ ✓ ✓ ✓ ✓ ✓ ✓
Iteration ✓ ✓ ✓ ✓ ✓
Job Role ✓ ✓ ✓ ✓ ✓
Journal Entry ✓ ✓ ✓ ✓ ✓ ✓
Milestone ✓ ✓ ✓ ✓ ✓
Milestone Path ✓ ✓ ✓ ✓ ✓
Note ✓ ✓ ✓ ✓ ✓ ✓ ✓
Note Tag ✓ ✓ ✓ ✓ ✓
Portfolio ✓ ✓ ✓ ✓ ✓ ✓ ✓
Program ✓ ✓ ✓ ✓ ✓ ✓ ✓
Project ✓ ✓ ✓ ✓ ✓ ✓ ✓
Project User ✓ ✓ ✓ ✓ ✓
Reserved Time* ✓ ✓ ✓ ✓ ✓
Risk ✓ ✓ ✓ ✓ ✓
Risk Type ✓ ✓ ✓ ✓
Step Approver ✓ ✓ ✓ ✓ ✓
Task ✓ ✓ ✓ ✓ ✓ ✓ ✓
Team ✓ ✓ ✓ ✓ ✓
Template ✓ ✓ ✓ ✓ ✓
Template Task ✓ ✓ ✓ ✓ ✓ ✓ ✓
Timesheet ✓ ✓ ✓ ✓ ✓
User ✓ ✓ ✓ ✓ ✓ ✓ ✓
Update ✓

 Object types available for each Workfront search module
Search Read Related Records
Approval Process ✓ ✓
Assignment ✓ ✓
Billing Record ✓
Billing Rate ✓
Company ✓ ✓
Document ✓ ✓
Document Folder ✓ ✓
Document Version ✓
Expense ✓
Expense Type ✓
Group ✓ ✓
Hour ✓
Hour Type ✓
Issue ✓ ✓
Iteration ✓
Job Role ✓
Journal Entry ✓
Milestone ✓
Milestone Path ✓
Note ✓
Note Tag ✓
Portfolio ✓ ✓
Program ✓
Project ✓ ✓
Project User ✓
Reserved Time* ✓
Risk ✓
Risk Type ✓
Step Approver ✓
Task ✓ ✓
Team ✓
Template ✓
Template Task ✓
Timesheet ✓ ✓
User ✓ ✓
User Delegation ✓

We recommend that you double check to ensure this works the way you would expect it to.

Event subscription filters in the Workfront > Watch Events modules

NOTE

We highly recommend using event subscription filters in your Watch Events modules.

The Workfront Watch Events module triggers scenarios based on a webhook that creates an event subscription in the Workfront API. The event subscription is a set of data that determines which events are sent to the webhook. For example, if you set up a Watch Events module that is watching for issues, then the event subscription sends only events related to issues.

By using event subscription filters, Fusion users can create event subscriptions that are a better fit for their use cases. For example, you can set up an event subscription in the Workfront API to send only issues that are in a specific project to the webhook, ensuring that the Watch Events module will only trigger for issues in that project. The ability to create narrower triggers improves scenario design by reducing the number of irrelevant triggers.

This is different from setting up a filter in the Workfront Fusion scenario. Without an event subscription filter, your webhook receives all events related to the object type you select. Most of these events would be irrelevant to the scenario, and must be filtered out before the scenario can continue.

The following operators are available in the Workfront > Watch events filter:

  • Equals
  • Not equals
  • Greater than
  • Less than
  • Greater than or equal to
  • Less than or equal to
  • Contains
  • Exists
    • This operator does not require a value, and the value field is absent.
  • Does not exist
    • This operator does not require a value, and the value field is absent.
  • Changed
    • This operator does not require a value, and the value field is absent.
    • This operator ignores the State field.
    • When using Changed, select Updated Events Only in the Record Origin field.
IMPORTANT

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.

INFO

Example: Consider a scenario that processes new issues that are assigned to a specific user, Ana.

Filter events by using an event subscription filter (recommended)

Using the event filter, you can set up the webhook to trigger the scenario when an issue is assigned to Ana when the issue is created. Ana has the userID b378489d8f7cd3cee0539260720a84b7.

If 100 issues are created in a day, but only two of them are assigned to Ana, the scenario would execute twice.

Filter events inside the scenario (not recommended)

To filter events so that only issues assigned to Ana are processed, you could create a filter after the Watch Events module.

If 100 issues are created in a day, but only two of them are assigned to Ana, the scenario would execute 100 times. 98 of the executions would stop at the filter, but the trigger module is still consuming data and performing operations in all of the executions.

For more information on event subscriptions, see FAQs - Event Subscriptions.

For more information on webhooks, see Instant triggers (webhooks) in Adobe Workfront Fusion

For more information on filters in scenarios, see Add a filter to a scenario in Adobe Workfront Fusion.

On this page