ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

ÃÛ¶¹ÊÓƵ Campaign modules

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

CREATED FOR:

  • User

With the ÃÛ¶¹ÊÓƵ Campaign modules, you can start an ÃÛ¶¹ÊÓƵ Workfront Fusion scenario based on events in your ÃÛ¶¹ÊÓƵ Campaign v7/v8 account, create, read, or update records, search for records using criteria you set, and perform custom API calls.

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.

Prerequisites

You must add the Fusion IP addresses to ÃÛ¶¹ÊÓƵ Campaign.

ÃÛ¶¹ÊÓƵ Campaign API information

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

API tag
v1.7.22

Connect ÃÛ¶¹ÊÓƵ Campaign to ÃÛ¶¹ÊÓƵ Workfront Fusion

IMPORTANT
We highly recommend creating a server-to-server connection. ÃÛ¶¹ÊÓƵ Campaign has updated their API to accept only server-to-server connections. If you are connecting to Campaign version 8 or higher, you must create a server-to-server connection.
For more information about Campaign’s new connection requirements, see Migration of Campaign technical operators to ÃÛ¶¹ÊÓƵ Developer Console in the Campaign documentation.

  1. In any ÃÛ¶¹ÊÓƵ Campaign 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 8-row-2 layout-auto html-authored no-header
    Connection type Select whether you are creating a basic connection or a server-to-server connection.
    Connection name Enter a name for this connection.
    Base URL Enter the base URL that you use to connect to your ÃÛ¶¹ÊÓƵ Campaign instance.
    Username If you are creating a basic connection, enter your ÃÛ¶¹ÊÓƵ Campaign username.
    Password If you are creating a basic connection, enter your ÃÛ¶¹ÊÓƵ Campaign password.
    Client ID If you are creating a server-to-server connection, enter your ÃÛ¶¹ÊÓƵ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Client Secret If you are creating a server-to-server connection, enter your ÃÛ¶¹ÊÓƵ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓƵ Developer Console.
    Environment Select whether you are connection to a Production or Non-production environment.
    Type Select whether you are connecting to a service account or a personal account.

  3. Click Continue to create the connection and go back to the module.

ÃÛ¶¹ÊÓƵ Campaign modules and their fields

When you configure ÃÛ¶¹ÊÓƵ Campaign modules, Workfront Fusion displays the fields listed below. Along with these, additional ÃÛ¶¹ÊÓƵ Campaign 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 ÃÛ¶¹ÊÓƵ Workfront Fusion.

Triggers

Watch records

This scheduled trigger module starts a scenario when a record changes.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Filter
Select whether you want to watch for new records, updated records, or both.
Resource
Select the resource that you want to watch for.
Fields to include in output
Select the fields that you want to include in the module's output.
Custom fields to include in output
For each custom field that you want to include in output, click Add and enter the name of the custom field.
Maximum number of returned results
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.

Actions

Create a record

This action module creates a new record in ÃÛ¶¹ÊÓƵ Campaign.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Resource
Select the type of ÃÛ¶¹ÊÓƵ Campaign record you want to create.
Fields
Select the fields that you want to set values for when the record is created, then fill in the values for those fields. Fields vary based on the type of record you select.
Custom fields
For each custom field that you want to add to the new record, click Add item and enter or map the field's name and value.

Make a custom API call

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

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

Select the action that you want the API call to perform.

Execute query

Write

Get entity if more recent

Select all

Push event

Headers

Add the headers of the request in the form of a standard JSON object.

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

Workfront Fusion adds the x-security token header automatically.

XML Body
Add the body content for the API call in XML, without the session element.

Delete Record

This action module deletes a single record from ÃÛ¶¹ÊÓƵ Campaign.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Resource
Select the type of resource that you want to delete.
ID
Enter or map the ID of the resourece you want to delete.

Perform an action

This action module performs a selected action on an object in the ÃÛ¶¹ÊÓƵ Campaign API.

For information on specific actions and fields, see ÃÛ¶¹ÊÓƵ Campaign - API Documentation.

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

Select the action to perform on the object.

  • List

    For available fields, see Search in this article.

  • Get

    For available fields, see Search in this article.

  • Create

    For available fields, see Create a record in this article.

  • Update

    For available fields, see Update a record in this article.

  • Delete

    For available fields, see Delete a record in this article.

Read a record

This action module reads a record from ÃÛ¶¹ÊÓƵ Campaign.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Resource
Select the type of ÃÛ¶¹ÊÓƵ Campaign record you want to read.
ID
Enter of map the ID of the record you want to read.
Fields to include in output
Select the fields that you want to include in the module's output.
Custom fields to include in output
For each custom field that you want to include in output, click Add and enter the name of the custom field.

Subscribe or unsubscribe

This action module subscribes a user to or unsubscribes a user from an information service.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Subscribe or unsubscribe
Select whether you want to subscribe or unsubscribe to the information service.
Service name
Select the service that you want to subscribe to or unsubscribe from.
Recipient email address
Enter or map the email address of the user you want to subscribe or unsubscribe to the information service.

Update record

This action module updates a single record in ÃÛ¶¹ÊÓƵ Campaign.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Resource
Select the type of ÃÛ¶¹ÊÓƵ Campaign record you want to create.
ID
Enter of map the ID of the record you want to update.
Fields
Select the fields that you want to update values for, then fill in the values for those fields. Fields vary based on the type of record you select.
Custom fields
For each custom field that you want to update, click Add item and enter or map the field's name and value.

Searches

This search module returns records based on the specified criteria.

Connection
For instructions on creating a connection to ÃÛ¶¹ÊÓƵ Campaign, see Create a connection to ÃÛ¶¹ÊÓƵ Campaign in this article.
Resource
Select the type of ÃÛ¶¹ÊÓƵ Campaign record you want to create.
Limit
Enter or map the maximum number of records you want the module to return during each scenario execution cycle.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43