ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

ÃÛ¶¹ÊÓƵ Workfront Planning modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

With the ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Planning account.

Access requirements

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

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

ÃÛ¶¹ÊÓƵ Workfront Planning API information

The ÃÛ¶¹ÊÓƵ Workfront Planning connector uses the following:

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

Create a connection to ÃÛ¶¹ÊÓƵ Workfront Planning

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

  1. In any ÃÛ¶¹ÊÓƵ Workfront Planning module, click Add next to the Connection box.

  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 layout-auto html-authored no-header
    Connection name Enter a name for this connection.
    Environment Select whether you are connecting to a production or non-production environment.
    Type Select whether you care connecting to a service account or a personal account.

    Client ID

    (Optional)

    		 Enter your ÃÛ¶¹ÊÓƵ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.

    Client Secret

    (Optional)

    		 Enter your ÃÛ¶¹ÊÓƵ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.

    Authentication URL

    (Optional)

    Enter the URL that your instance of Workfront will use to authenticate this connection.

    The default value is https://oauth.my.workfront.com/integrations/oauth2.
    Host prefix

    Enter your host prefix.

    The default value is origin-.

  3. Click Continue to save the connection and return to the module.

ÃÛ¶¹ÊÓƵ Workfront Planning modules and their fields

Triggers

Watch Events

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

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 ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Planning in this article.
Object type
Select whether you want to watch records, record types, or workspaces.
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.

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 ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Planning in this article.
Record type ID
Enter or map the ID of the field you want to delete.

Make a custom API call

This module makes a custom API call to the ÃÛ¶¹ÊÓƵ Workfront Planning API.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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 in ÃÛ¶¹ÊÓƵ Workfront Fusion.
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.

Uncategorized

Create a record

This action creates a single record in Workfront Planning.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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
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 ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Planning, specified by its ID.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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.
Maximum number of returned records
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Get record types

This action module retrieves a list of record types in an ÃÛ¶¹ÊÓƵ Workfront Planning account.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ Workfront Planning in this article.

Update record

This action updates a single record in Workfront Planning.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Workfront Planning, see Create a connection to ÃÛ¶¹ÊÓƵ 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
These fields are based on the record type you selected.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43