Workfront

Overview

Events

• Field Updated

  NOTE: Please be aware that not all fields will trigger this Event when an update is made to them. We allow users to watch any field, but only a subset of those you can pick from will trigger the Flow. At this time we have no way to tell which fields do and which fields don’t trigger this Event. This is especially true for custom fields containing special characters, e.g. >“^%_=,@; you may have some success with custom fields containing characters *~`< but we recommend custom fields be named with only numbers and letters, with no spaces between words.

  Start Flow when a specific field is updated.

  Note: Additional fields may be available depending on the connection and options you choose.

  Options:

  • Record Type (dropdown) : Select the record type that you want to monitor for updates. For example, if you want to start the Flow each time a record field updated in a Project, you should select Project from the dropdown list.
  • Field (text) : Please specify the fields of the record you want to watch for updates.

  Outputs:

  • Record (object) : This will be the record that was updated. The fields will be dynamically generated, and you will be able to choose fields that will be displayed. Click the bottom right gear symbol to edit the output field.

• New Record - Real Time

  Runs a Flow everytime a new record is created. This is a webhook event.

  You must have created an API key under ‘Setup > System > Contact Information’ before this monitor will run. Otherwise you will get an ‘Unauthorized’ response.

  Options:

  • Record Type (dropdown) : Select the record type that you want to monitor for any record addition. For example, if you want to start the Flow each time a new Project is created, you should select Project from the dropdown list.

  Output Fields

  • Record
    • Dyanmically Generated: This will be the record that was created. The fields will be dynamically generated, and you will be able to choose fields that will be displayed. Click the bottom right gear symbol to edit the output field.

  Known Issues:

  • Uploading a document to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • Adding a comment to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • A limited set of data is sent to the webhook, please see the list of Event Subscription Resource Fields listed by Workfront for a list of fields that will have populated values for your selected record type.

• New Record

  A new record has been created Note: Additional fields may be available depending on the account and options you choose.

  Options:

  • Record Type (dropdown) : Select the record type that you want to monitor for any record addition. For example, if you want to start the Flow each time a record added in a Project, you should select Project from the dropdown list.
  • Filter (text) : Specify filter for the records.

  Outputs:

  • Record (object) : This will be the record that was added. The fields will be dynamically generated, and you will be able to choose fields that will be displayed. Click the bottom right gear symbol to edit the output field.

  Known Issues:

  • Monitoring for the `Issue` record type will not pick up 100% of new `Issues` (~ 4% of records missed).

• Record Deleted - Real Time

  Runs a Flow everytime a record is deleted. This is a webhook event.

  You must have created an API key under ‘Setup > System > Contact Information’ before this monitor will run. Otherwise you will get an ‘Unauthorized’ response.

  Options:

  • Record Type (dropdown) : Select the record type that you want to monitor for any record deletion For example, if you want to start the Flow each time a record deleted in a Project, you should select Project from the dropdown list.

  Output Fields

  • Record
    • Dyanmically Generated: This will be the record that was deleted. The fields will be dynamically generated, and you will be able to choose fields that will be displayed. Click the bottom right gear symbol to edit the output field.

  Known Issues:

  • Uploading a document to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • Adding a comment to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • A limited set of data is sent to the webhook, please see the list of Event Subscription Resource Fields listed by Workfront for a list of fields that will have populated values for your selected record type.

• Record Updated - Real Time

  Runs a Flow everytime an existing record is updated. This is a webhook event.

  You must have created an API key under ‘Setup > System > Contact Information’ before this monitor will run. Otherwise you will get an ‘Unauthorized’ response.

  Options:

  • Record Type (dropdown) : A list of your Workfront record types. Select the record type that you wish to monitor for updates. For example, if you want to start the Flow each time a record updated in a Project, you should select Project from the dropdown list.

  Output Fields:

  • Record
    • Dyanmically Generated: This will be the record that was updated. The fields will be dynamically generated, and you will be able to choose fields that will be displayed. Click the bottom right gear symbol to edit the output field.

  Known Issues:

  • Uploading a document to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • Adding a comment to a `Task` will not trigger the webhook. This is an issue with the Workfront API.
  • A limited set of data is sent to the webhook, please see the list of Event Subscription Resource Fields listed by Workfront for a list of fields that will have populated values for your selected record type.

• Record Updated

  Record Updated

  Record Updated allows you to start a Flow whenever a record is updated in Workfront.

  Options

  • Record Type (dropdown list) : A list of your Workfront record types. Select the record type that you wish to monitor for updates.
  • Filter: Use this option to specify a filter so that the Flow only starts when records that are updated match the filter criteria.

  Output Fields

  • Standard Output Fields
    • Open up the fields menu by clicking the cog wheel at the bottom right of the card to choose the fields that contain the information you want from the updated record. (Name, Description, etc)
  • Custom Output Fields
    • Where applicable, the fields menu will also display any of the custom fields available in your Workfront instance. Select these if they’re necessary for your scenario.
  • Context
    • Execution ID (text): The unique identifier that is generated each time the Flow runs.

Actions

• Attach Project Template

  This action will attach a template to an existing project in Workfront. It also allows you to specify the predecessor and parent task IDs, if necessary.

  Input Fields

  • Template
    • Project ID (text): The unique identifier of the Workfront project you want to attach a template to. The project id could be found after the ID= on the URL. For example https://attask-ondemand.com/project/view?ID=5bc67cd801a3e36b35232c9f29c25b0c, the id is in bold.
    • Template ID (text): The unique identifier of the template you want to attach to the project above. The template id could be found after the ID= on the URL. For example https://attask-ondemand.com/template/view?ID=5abaa7f50101e573fbd598bb61f042d5, the id is in bold.
    • Predecessor Task ID (text): The unique identifier of the predecessor task ID. (Optional)
    • Parent Task ID (text): The unique identifier of the parent task ID. (Optional)
    • Exclude Task IDs (list of text): A list of the unique identifiers of the task IDs you wish to exclude from the template attachment. (Optional)

• Create Record

  Create Record

  Create Record allows you to create a new record in Workfront as a step in your Flow.

  Note: Different record types have different required fields, so always make sure you are at least providing the minimum number of input fields. For example, if you want to create an issue, in addition to a name for the issue, you will need to provide a valid project ID. This can be a field referenced from another step in your Flow or manually typed into the input field.

  Options

  • Record Type (dropdown) :
    • Select the record type that you want to create. For example, if you want to create a Project, you should select Project from the dropdown list and then make sure you have access to data from previous steps to use when creating the Project.

  Input Fields

  • Project
    • Standard Input Fields
      • The card will initially display a few standard fields based on whichever record type you select. You can also open up the fields menu by clicking the cog wheel at the bottom right of the card to use other fields available in Workfront.
    • Custom Input Fields
      • Where applicable, the fields menu will also display any of the custom fields available in your Workfront instance.

  Output Fields

  • Record ID (text): Each new record will out put an ‘ID’ field. This ‘ID’ is the Workfront ID of that record and is the same as the ID you can find in the URL of any specific Workfront record.

• Custom API Action

  This action allows you to make a custom, authenticated HTTP call to the Workfront v9.0 API.

  NOTE: This is not like any of the other Workfront cards; this card shows some of what goes on behind the scenes in other cards. If It may help if you refer to the Workfront documentation. Please note that this card uses v9.0 of the API.

  Options

  • Request Type (dropdown): your available HTTP request methods. There are 5 supported HTTP request methods (sometimes called verbs) in custom API calls:

    • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

    • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.

    • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.

    • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

    • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

  Input Data

  • Relative URL (text): the address on the web server you are attempting to interact with. Relative URL means that you don’t have to explicitly specify the protocol at the beginning of the URL (such as “http://“). This suggests to the web server that the interaction is occurring on the server (in this instance).

    Example: /api/conversations.create

  • Query (object or text): JSON object that determines the action taken at the URL.

    Example: {"name":"something-urgent"}

  • Headers (object): JSON that determines the content type of the request. This will usually be a replica of the example below.

    Example: {"Content-type":"application/json"}

    Note: if you’re getting errors that are difficult to determine the origin of, please take a look at modifying headers based on the Workfront documentation. If your Workfront Custom API Action card is returning a 422 HTTP Request Error, try using a “Content-Type”:“text/plain” header.

  Output Data

  • Status Code (Number): the success or failure of your HTTP request. Here is a list of all status codes.

  • 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, meaning that some are unlikely to be useful to you.

  The response headers are dependent on the HTTP request you choose in options.

  • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

• Delete Record

  Destroy an existing record from workfront.

  Options

  • Record Type (dropdown) : Select the record type that you want to remove a record from. For example, if you want to remove a record from a Project, you should select Project from the dropdown list.

  Input Fields

  • Record
    • Record ID (text) : This record unique identification number. This ‘ID’ is the Workfront ID of that record and is the same as the ID you can find in the URL of any specific Workfront record, after ID=. For example this is the url for project record type https://attask-ondemand.com/project/view?ID=5bc67cd801a3e36b35232c9f29c25b0c, the id is in bold.

• Download Document

  Downloads a document based on the unique Workfront ID of the document.

  Inputs:

  • Document ID (text) : The Workfront ID of the document you want to download. Document ID could be found on the url after ID=, for example https://.attask-ondemand.com/document/view?ID=5b512c4b02b45fa44cc90352cab1bc4c, the id is in bold.

  Outputs:

  • File Content (file) : The document from Workfront, this file can only be used in input fields that accept the ‘File’ field type.

• Filter Records

  Return a set of records based on a custom filter

• Perform Record Action

  Perform Record Action

  Perform a variety of actions to an existing record in Workfront.

  Options

  • Record Type (dropdown) : Select the record type that you want to do an action. For example, if you want to peform a record action in a Project, you should select Project from the dropdown list.

  • Action (dropdown): The action you want to perform to the existing Workfront Object. This will depends on record types you choose, some action only applicable to different kind of record type. Some possible action :

    • Calculate data extension
    • Check in
    • Check out
    • Create proof
    • Get total size for documents
    • Is linked document?
    • Is proof auto-generation enabled?
    • Move
    • Unlink documents

  Input Fields

  • Record
    • Record ID (text) : The record unique identification number. ID of that record and is the same as the ID you can find in the URL of any specific Workfront record. This is the ID of the record you’re performing the action on. For example this is the url for project record type https://attask-ondemand.com/project/view?ID=5bc67cd801a3e36b35232c9f29c25b0c, the id is in bold.
  • Arguments : The available “arguments” input fields vary based on the Action selected in the Options.
    • When “Move” is Selected:
      • objID (text): The ID of the record you’re moving your “Record ID” into.
      • docObjCode (text): Workfront-specific object codes based on the type of object that the “objID” is referencing. Common ones are “PROJ” for Project, “TASK” for Task, “OPTASK” for Issue, and “USER” for User. To see the full list, check Workfront’s documentation here.

  Output Fields

  • Result (object) This will vary depend on the action selected in options.

• Read Record

  Read Record

  Read a record of any type by providing the the unique Workfront ID for the record. Outputs will vary based on the record type chosen from the options menu.

  Options:

  • Record Type (dropdown):
    • Select the record type that you want to read. For example, if you want to create a Project, you should select Project from the dropdown list. Here are the options:
    • Document Folder
    • Document Version
    • Document
    • Note
    • Task
    • Timesheet
    • Job Role
    • Project
    • Team
    • Reserved Time
    • Company
    • Issue
    • Expense
    • Billing Rate
    • Template Task
    • Portfolio
    • Note Tag
    • Project User
    • Approval
    • Program
    • Milestone
    • User
    • Milestone Path
    • Step Approver
    • Assignments
    • Group
    • Journal Entry

  Inputs:

  • Record ID (text): the unique Workfront ID of the record you wish to read.

  Outputs:

  • Various : The outputs will vary and additional fields may be available depending on the account and record type you choose.

• Read Related Records

  Read Related Records

  Read records related to a parent record by providing the the unique Workfront ID for the parent record. Outputs will vary based on the record type chosen from the options menu.

  Options:

  • Parent Record Type (dropdown) : Select the parent record type that you want to read. For example, if you want to read a Project related record, you should select Project from the dropdown list. Here are some example options:

    • Document Folder
    • Document
    • Task
    • Timesheet
    • Project
    • Company
    • Issue
    • Portfolio
    • Approval
    • User
    • Assignments
    • Group

  • Related Record (dropdown) :

    • Varies: this can only be a record type that exists within the parent record.
    • Example: if ‘Document Folder’ is chosen as the Parent Record Type, then the related record chosen must be either children or documents.

  Inputs:

  • Parent Record ID (text) : The unique Workfront ID of the record you wish to read.

  Outputs:

  • Related Records (list of object): The output will always be a list of objects, and the items within each object will vary based on the related record type chosen.

• Search Records

  Search Records allows you to search for a record or records in Workfront as a step in your Flow.

  Options

  • Record Type (dropdown):
    • Select the record type that you want to search. For example, if you want to search a Project, you should select Project from the dropdown list and then make sure you have access to data from previous steps to use when creating the Project.
  • Result Set (dropdown list):
    • Either choose to only get the first result that matches your search criteria or all the results that match your search criteria.

  Input Fields

  • Search : The fields here are the search criteria for the records you’ll get back.
    • Standard Input Fields
      • The card will initially display a few standard fields based on whichever record type you select. You can also open up the fields menu by clicking the cog wheel at the bottom right of the card to use other fields available in Workfront.
    • Custom Input Fields
      • Where applicable, the fields menu will also display any of the custom fields available in your Workfront instance.

  Output Fields

  • Record : The fields here contain the results of your search and will return information differently depending on the Result Set option.
    • Standard Output Fields
      • The card will initially display a few standard fields based on whichever record type you select. You can also open up the fields menu by clicking the cog wheel at the bottom right of the card to use other fields available in Workfront.
    • Custom Output Fields
      • Where applicable, the fields menu will also display any of the custom fields available in your Workfront instance.

• Update Record

  Updates a record of any type by using the the unique Workfront ID for the record.

  Options:

  • Record Type (dropdown) :
    • Select the record type that you want to make updates. For example, if you want to update a Project, you should select Project from the dropdown list. These are some record type example:
    • Document Folder
    • Document Version
    • Document
    • Note
    • Task
    • Timesheet
    • Job Role
    • Project
    • Team
    • Reserved Time
    • Company
    • Issue
    • Expense
    • Billing Rate
    • Template Task
    • Portfolio
    • Note Tag
    • Project User
    • Approval
    • Program
    • Milestone
    • User
    • Milestone Path
    • Step Approver
    • Assignments
    • Group
    • Journal Entry

  Inputs:

  • Record ID (text): The unique Workfront ID of the record you wish to read. This ‘ID’ is the Workfront ID of that record and is the same as the ID you can find in the URL of any specific Workfront record, after ID=.

  Outputs:

  • There are no output fields

• Upload Document

  This card allow a file to be upload as document on workfront.

  Options

  • Record Type (dropdown) : Select the record type that want to add a document. For example, if you want to remove add a document to a Project, you should select Project from the dropdown list.

  Input Fields

  • Document
    • File Content (file) : The file / document you want to upload to Workfront.
    • Name (text) : The name of the file it will be saved as.

  Output Fields

  • Document
    • ID (text) : The newly upload identification code on Workfront.