DocuSign modules

Last update: Tue Jun 27 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

User

The Adobe Workfront Fusion DocuSign modules enable you to monitor and retrieve envelope status, search and retrieve envelopes, or download and send a document to sign in your DocuSign account.

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**

Current license requirement: No Workfront Fusion license requirement.

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime Adobe Workfront Plan, your organization must purchase Adobe Workfront Fusion as well as Adobe Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Legacy product requirement: 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.

Prerequisites

To use DocuSign modules, you must have a DocuSign account.

Connect DocuSign to Workfront Fusion connect-docusign-to-workfront-fusion

To create a connection for your DocuSign modules:

Click Add next to the Connection box when you begin configuring the first DocuSign module.
Enter the following:

Connection name

Enter a name for the new DocuSign connection

Account type

Select whether you the account you want to connect to is a production account or a demo account.

Continue as described in Create a connection to Adobe Workfront Fusion - Basic instructions.

DocuSign modules and their fields

When you configure DocuSign modules, Workfront Fusion displays the fields listed below. Along with these, additional DocuSign 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
Actions

Triggers

Watch envelopes

This trigger module starts a scenario when an envelope is sent, delivered, signed, completed, or declined.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect the module's app or web service to Workfront Fusion in the article Create a scenario in Adobe Workfront Fusion.

Account

Select the account that contains the records you want to watch.

Event type

Select the type of event that you want to watch.

Document completed
Document declined
Document sent
Document signed
New document in Inbox

Output fields

Select the fields that you want to include in the module output.

Limit

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

Custom API Call

This action module allows you to perform a custom API call.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Enter or map the account that you want to use to access the DocuSign API.

URL

Type the address on the web server that you want the module to interact with.

You can type a relative URL, which means that you don't have to include the protocol (such as http://) at the beginning. This suggests to the web server that the interaction is occurring on the server.

For example: /api/conversations.create

Method

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

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"}

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.

Limit

Enter or map the maximum number of results to be worked with during one execution cycle.

INFO

Example: List Envelopes

The following API call returns envelopes from the specified date in your DocuSign account:

URL: /v2.1/accounts/{accountId}/envelopes/

Method: GET

Query String:

Key: from_date
Value: YYYY-MM-DD

Specifies when the request begins checking for status changes for envelopes in the account.

The result can be found in the module’s Output under Bundle > Body > envelopes.

In our example, 6 envelopes were returned:

Download a document

This action module downloads a single document.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the document you want to download.

Envelope ID

Enter or map the ID of the envelope you want to download.

Document ID

Enter or map the ID of the document you want to download.

Certificate

Select Yes if you want to include the envelope signing certificate in the download.

Documents by User ID

Select Yes if you want to allow recipients to retrieve documents by User ID. For example, if a user is included in two different routing orders with different visibilities, using this option returns all of the documents from both routings.

Encrypt

Select Yes if you want the PDF bytes returned in the response to be encrypted for all the key managers configured on your DocuSign account.

Language

Select the language.

Show Changes

When set to Yes, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials are outlined in red.

Watermark

Select No to remove the watermark from the PDF documents.

Read an envelope

This action module reads information about an envelope in DocuSign using the envelope ID.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the document you want to read information from.

Envelope ID

Enter or map the ID contains the document you want to read information from.

Outputs

Select the properties that you want to appear in the module's output.

Upload a file to an envelope

This module uploads a specified file to an existing envelope in DocuSign.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the envelope where you want to upload a file.

Envelope ID

Enter or map the ID of the envelope where you want to upload a file.

Source file

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

Create a new envelope

This action module creates a new envelope from a template. It returns the new envelope’s ID, as well as the status of the new envelope.

Connection

Account

Select the account that contains the envelope where you want to upload a file.

Template

Select the template that you want to create the new envelope from. Templates are available based on the Account you selected.

After creation

Select whether you want to save the envelope as a draft or send it for signing.

Template recipients

Select the recipient of this envelope

Add Recipient to Envelope

This action module adds one or more recipients to an existing envelope. If the envelope has already been sent, the recipient is sent an email. This module is not valid for envelopes that have already been completed.

Connection

Account

Select the account that contains the envelope where you want add recipients.

Envelope ID

Select the or map the ID of the envelope where you want to add the recipient.

Recipient type

Select the type of recipient that you want to add to the envelope.

Agent
Carbon copy
Certified delivery
In-person signer
Intermediary
Signer

Enter or map the email address of the recipient you want to add to the envelope.

Name

Enter or map the name of the recipient you want to add to the envelope.

Routing order

Enter or map the routing number for the recipient. Routing number determines the order in which recipients receive and sign your documents.

Email body

Enter or map the body (content) of the email is sent to the recipent.

Email subject

Enter or map the subject of the email that is sent to the recipient.

Private message

Only the selected recipient sees the private message, as well as the general message. The private message is limited to 1000 characters.

Authentication

Select the authentication method that you want to use to confirm the recipient's identity.

None
Access code

Enter or map the access code.
Phone

Enter or map the phone number
SMS

Enter or map the phone number

Add custom field

This action module adds a custom field to the document

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the document where you want to add a custom field.

Envelope ID

Enter or map the ID of the envelope that contains the document where you want to add a custom field.

Field name

Enter or map a name for the new field that you want to add.

Required

Enable this option if you want the added field to be a required field.

Show field

Enable this option if you want the field to be visible.

Value

Enter or map the value (contents) of the added field.

Modify custom field

This action module modifies a custom field using the field name.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the document where you want to modify a custom field.

Envelope ID

Enter or map the ID of the envelope that contains the document where you want to modify a custom field.

Field ID

Enter or map the ID of the field you want to modify.

Field name

Enter or map the name of the field you want to modify.

Required

Enable this option if you want the modified field to be a required field.

Show field

Enable this option if you want the field to be visible.

Value

Enter or map the value (contents) of the modified field.

Send envelope

This action module sends a draft envelope to its recipients.

Connection

For instructions about connecting your DocuSign account to Workfront Fusion, see Connect DocuSign to Workfront Fusion in this article.

Account

Select the account that contains the draft envelope that you want to send to its recipients.

Envelope ID

Enter or map the ID of the draft envelope that you want to send to its recipients.

recommendation-more-help

5f00cc6b-2202-40d6-bcd0-3ee0c2316b43