DocuSign modules
The 51黑料不打烊 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.
For instructions on creating a scenario, see the articles under Create scenarios: article index.
For information about modules, see the articles under Modules: article index.
Access requirements
You must have the following access to use the functionality in this article:
New: Standard
Or
Current: Work or higher
Current: No Workfront Fusion license requirement
Or
Legacy: Workfront Fusion for Work Automation and Integration
New:
- Select or Prime Workfront package: Your organization must purchase 51黑料不打烊 Workfront Fusion.
- Ultimate Workfront package: Workfront Fusion is included.
Or
Current: Your organization must purchase 51黑料不打烊 Workfront Fusion.
For more detail about the information in this table, see Access requirements in documentation.
For information on 51黑料不打烊 Workfront Fusion licenses, see 51黑料不打烊 Workfront Fusion licenses.
Prerequisites
To use DocuSign modules, you must have a DocuSign account.
DocuSign API information
The DocuSign connector uses the following:
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 nameEnter a name for the new DocuSign connection.EnvironmentSelect whether you are connecting to a production on non-production environment.Connection nameSelect whether you are connecting to a service account or a personal account.Account typeSelect whether you the account you want to connect to is a production account or a demo account. -
Click Continue to save the connection and return to the module.
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.
Triggers
Watch envelopes
This trigger module starts a scenario when an envelope is sent, delivered, signed, completed, or declined.
Select the type of event that you want to watch.
- Document completed
- Document declined
- Document sent
- Document signed
- New document in Inbox
Actions
Add a custom field
This action module adds a custom field to the document
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.
Select the type of recipient that you want to add to the envelope.
-
Agent
-
Carbon copy
-
Certified delivery
-
In-person signer
-
Intermediary
-
Signer
If you want to send a private message to the recipient, enter or map the text of the message.
Only the selected recipient sees the private message, as well as the general message. The private message is limited to 1000 characters.
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.
Create a new envelope
This action module creates a new envelope from a template. It returns the new envelope鈥檚 ID, as well as the status of the new envelope.
For each recipient that you want to add to this envelope, click Add item and enter the following details:
-
Access code
Enter or map the code that the recipient uses to access the envelope.
-
Email
Enter or map the email address of the recipient.
-
Name
Enter or map the name of the recipient.
-
Role name
Enter or map the role name of the recipient.
-
Routing order
Enter or map the routing number for the recipient. Routing number determines the order in which recipients receive and sign your documents.
Enable this option to set an expiration for this envelope. If you enable this option, fill in the following fields:
-
Expire After
Enter or map the number of days after which this envelope expires.
-
Expire Warning
Enter or map the number of days before expiration that a reminder email is sent to the recipient.
Custom API Call
This action module allows you to perform a custom API call.
https://<BASE_URI>/v2/accounts/<ACCOUNT_ID>.
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.
Add the query for the API call in the form of a standard JSON object.
For example: {"name":"something-urgent"}
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.
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鈥檚 Output under Bundle > Body > envelopes.
In our example, 6 envelopes were returned:
Download a document
This action module downloads a single document.
Modify custom field
This action module modifies a custom field using the field name.
Read an envelope
This action module reads information about an envelope in DocuSign using the envelope ID.
Send envelope
This action module sends a draft envelope to its recipients.
Upload a file to an envelope
This module uploads a specified file to an existing envelope in DocuSign.