Skip to main content
Skip table of contents

Adobe Workfront Connector v1.0

1. Prerequisites and Additional Steps, Developer Key

 

Log into the Workfront Portal with the correct credentials for Asset Management.

After login user will be redirected to the dashboard page.

image-20241225-142624.png

 

For OAuth settings and callback URL enrollments, go to the OAuth app page (Setup > System > OAuth2 Applications)

image-20241225-142808.png

 

To see the ClintID and Clint Secret click the related OAuth Applications Edit icon.

image-20241225-143008.png

image-20241225-144305.png

 

2. Connector Action & Tests

Action Name / Method

Project Search

Action Description

Find and get project by ID. Retrieves project all data section and custom forms data

Test Case

Project search/Get

Request Body Name

Parameter

 

Id

 

Fields

Getting project data example:

Getting project & Custom Forms data example:

Custom Form on Workfront Project page:

 

Action Name / Method

Document Search

Action Description

Find and get document by ID. Retrieves document all data

Test Case

Documen search/Get

Request Body Name

Parameter

 

Id

 

Fields

Action Name / Method

Download Asset

Action Description

Download document by providing the URL

Test Case

Download document from Workfront

Request Body Name

Parameter

 

Asset Name

 

Download URL

Download URL can be any valid resource file URL or we can use the document retrieved from the document search action as shown in the below image.

 

How to Approve Document

Go to the projects page and select the required project.

Go to the document section and click on the document details page.

Click on the Approvals section and add the relevant Approver person. An email will be sent to the user for approval.

How to define Custom Forms on Workfront

  1. Go to Setup > Custom Forms page.

  2. Click on New Custom Form

How to register Webhook callback URL using POSTMAN

The subscription resource contains the following fields.

  • objId (optional)

    • String - The ID of the object of the specified objCode for which events are fired. If this field is not specified, the user receives events for all objects of the specified type.

  • objCode (required)

    • String - The objCode of the object being subscribed to changes. The possible values for objCode are listed in the table below.

Object

objCode

Assignment

ASSGN

Company 

CMPY

Dashboard

PTLTAB

Document

DOCU 

Expense

EXPNS

Hour

HOUR

Issue

OPTASK

Note

NOTE

Portfolio

PORT

Program

PRGM

Project

PROJ

Report

PTLSEC

Task

TASK

Template

TMPL

Timesheet

TSHET

User

USER

  • eventType (required)

    • String - A value that represents the type of event to which the object is subscribed. The available event types include:

      • CREATE

      • DELETE 

      • UPDATE

  • URL (required)

    • String - The URL of the endpoint to which subscription event payloads are sent via HTTP.

  • authToken (required)

    • String - The OAuth2 bearer token used to authenticate with the URL specified in the “URL” field. 

  1. Get an Access token. Fill in the OAuth details in Postman and click on the Get Access token button.

    image-20250102-065320.png

image-20241225-144911.png

Get existing WEBHOOK subscriptions:

image-20241225-145016.png

Create new WEBHOOK subscriptions

image-20241225-145039.png

After ensuring the user has administrator access and forming the subscription resource, you are ready to create event subscriptions.

Use the following syntax to construct the URL.

Request URL:

CODE
POST https://<HOSTNAME>/attask/eventsubscription/api/v1/subscriptions

Request Headers:

Header Name

Header Value

Content-type

application/json

sessionID

sessionID value

Request Body Example:

CODE
{
    "objCode": "PROJ",
    "eventType": "UPDATE",
    "url": "http://requestb.in/ua5hi2ua",
    "authToken": "EauthTokenWorkfrontRocks1234_"
}

Response Code

Description

Response Code

Description

201 (Created)

The event subscription was successfully created.

400 (Bad Request)

The URL field of the subscription resource was deemed invalid.

401 (Unauthorized)

The sessionID provided was empty or deemed invalid.

403 (Forbidden)

The user that matches the provided sessionID does not have administrator access.

Response Headers Example:

Response Headers

Example

Content-Length

→0

Date

→Wed, 05 Apr 2017 21:23:33 GMT

Location

→https://<HOSTNAME>/attask/eventsubscription/api/v1/subscriptions/750a636c-5628-48f5-ba26-26b7ce537ac2

Server

→Apache-Coyote/1.1

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.