Automate the process of sending a document to an individual or list of recipients for digital signature using Docusign eSignature. For example, automate employee onboarding and offboarding, or send non-disclosure agreements, legal agreements, and statements of work. Use ServiceNow data in document templates and enable users to upload documents for signature as needed.

Request apps on the Store

Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

IntegrationHub subscription

This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

Spoke version

Docusign eSignature spoke v4.0.1 is the latest version.

Spoke dependencies

If you’re having trouble installing the app, ensure that these dependent plugins are installed:

  • ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
  • ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
  • ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
Note: Some of these plugins are licensable features and require an appropriate license if used outside the spoke implementation. For information on licenses, contact your account manager.

Compatible versions

This spoke was built for Docusign eSignature API version v2 or v2.1, but may be compatible with later versions.

Key features

Docusign eSignature spoke enables a flow designer to:

  • Automate the process of sending a document from a ServiceNow attachment or Docusign eSignature template to an individual or recipient list for digital signature.
  • Discover and synchronize Docusign eSignature accounts and templates in ServiceNow.
    • Retrieve a list of accounts and associated templates from Docusign eSignature and then insert or update them as records in the Accounts [sn_docusign_spoke_accounts] and Templates [sn_docusign_spoke_docusign_templates] tables using the Get Accounts subflow.
    • Retrieve templates associated with a specified Docusign eSignature account and then insert or update them as records in the Templates [sn_docusign_spoke_docusign_templates] table using the Get Templates Per Account subflow.
  • Copy and customize sample flows for sending templates and on-demand document requests.
  • Pause a flow until a document is signed. A scripted REST API webhook waits for the recipient to sign the document.
  • Use values from a signed document in a flow.
  • Attach a completed Docusign eSignature document to a ServiceNow record for auditing purposes.
  • Manage envelopes and users.

Spoke requirements

  • Docusign eSignature account
  • Docusign eSignature administrator credentials
  • Docusign eSignature application configured to integrate with ServiceNow
  • Docusign eSignature application details such as client ID, integrator key, secret keys, and RSA keypairs
  • ServiceNow IntegrationHub subscription
    Note: Ensure that you have activated the Flow Designer support for the Service Catalog (com.glideapp.servicecatalog.flow_designer) plugin.

See the Docusign Developer Center documentation for instructions on creating and configuring custom applications.

Spoke flows

The Docusign eSignature spoke provides sample flows to demonstrate automating Docusign tasks. Use Docusign eSignature spoke actions to automate any tasks desired by your organization. To customize a sample flow, copy it to a new application scope. Available sample flows include:

Flow Description
Send a Document for Digital Signature Sends a document to Docusign for a digital signature when a Service Catalog request is created by the Send a Document for Digital Signature item. Before using this flow, activate the Send a Document for Digital Signature catalog item.
Send employment offer to candidate using Docusign template Sends a Docusign envelope to a user using a template. For example, use this flow to send a job offer to a candidate. Before using this flow, activate the Demonstrate Template - Send Job Offer to Candidate catalog item.

The Docusign eSignature spoke adds catalog items for use with the Docusign eSignature spoke sample flows. Before triggering a Docusign eSignature spoke sample flow, activate these catalog items.

Catalog item Description
Send a Document for Digital Signature Sends a document for digital signature in Docusign.
Demonstrate Template - Send Job Offer to Candidate Sends a job offer using a Docusign template.

Spoke subflows

The Docusign eSignature spoke provides sample subflows to demonstrate automating Docusign tasks. To customize a sample subflow, copy it to a new application scope. Available sample subflows include:

Category Subflow Description
Envelope Management Attach Docusign Envelope To ServiceNow Record Attaches all the documents in an envelope to a ServiceNow record.
Get & Set Docusign Field Data Processes a list of catalog item variables and updates a draft envelope with each variable value.
User Management Create User Creates a user including the permission profile and group memberships.
Update User Updates a user including the permission profile and group memberships.
Templates Management Get Templates Per Account Retrieves templates from a Docusign account and stores them in the Templates table.
Default Docusign Webhook Sample Subflow Retrieves the recipient details for the specified envelope.
Account Management Get Accounts Retrieves Docusign Accounts and Templates related to every account and store them in Accounts and Templates table respectively.

Spoke actions

The Docusign eSignature spoke provides actions to automate Docusign tasks when events occur in ServiceNow. Available actions include:

Category Action Description
Account Management Look up Account Signature Providers Retrieves a list of signature providers that the specified account can use.
Look up Accounts by Alias Retrieves accounts associated with the spoke Connection and Credential alias record.
Look up Role ID Retrieves the roles ID for the specified role name.
Bulk Envelopes Management Create Bulk Send List Creates a bulk send list.
Create Bulk Send Request Creates a bulk send request based on an existing bulk send list using an envelope or template.
Create Bulk Send Test Request Creates a bulk send test request for testing compatibility with the existing envelope or template.
Delete Bulk Send List Deletes the specified bulk send list.
Look up Bulk Send Batch Envelopes Stream Retrieves the envelopes from the specified bulk send batch.
Look up Bulk Send Batch Status Retrieves the general status of the specified bulk send batch such as number of successes, number pending, number of errors and so on.
Look up Bulk Send Batches Stream Retrieves the information of the bulk send batches.
Look up Bulk Send List Retrieves the specified bulk send list.
Look up Bulk Send Lists Retrieves a list of the bulk send lists.
Update Bulk Send Batch Action Performs a bulk action (resend, correct or void) on the specified bulk send batch.
Update Bulk Send Batch Status Updates the name of the specified bulk send batch.
Update Bulk Send List Updates the specified bulk send list.
Document Signature Look up Embedded Signing URL Creates a signing URL that is embedded into an application. User can sign the document without leaving the application.
Note: Signing URL is active for 300 seconds and can be sent to one recipient at a time.
Look up Embedded Signing URL Inline Retrieves a URL which enables you to embed the recipient view of the on Docusign.
Document Management Add Document to Envelope Adds documents to envelope.
Attach Combined Document to ServiceNow Record Attaches Docusign documents to a ServiceNow record.
Attach Docusign Document to ServiceNow Record Retrieves a signed Docusign document and attaches it to a ServiceNow record.
Look up Document ID by Name Retrieves the document ID from an envelope using the specified document name.
Look up Documents in an Envelope Returns a list of documents with an ID and name in the given Docusign envelope.
Replace Document in an Envelope Replaces documents to envelope.
Envelope Management Add Recipient to Envelope Adds the specified recipient to the specified envelope.
Note:
  • Recipient ID used in this action is associated with the envelope and is different from the Recipient ID used in the Get All Template Fields action.
  • Administrator enters a numeric value for this Recipient ID.
Add Recipients to Envelope Adds the specified recipients to the specified envelope.
Attach Docusign Certificate To ServiceNow Record Attaches a Docusign certificate to a ServiceNow record.
Cancel Envelope Cancels an in-process envelope.
Create Draft Envelope from Template Creates a draft envelope from an existing Docusign template.
Create Envelope from Composite Template Creates an envelope from an existing composite template.
Look up Field ID Retrieves the ID of the specified field from the specified draft envelope.
Look up Field Value Retrieves the value of the specified field from the specified envelope.
Look up Fields Retrieves the list of fields associated to a document in a draft envelope.
Look up Recipient ID by Role Name Retrieves the recipient ID of the specified role name from the specified envelope.
Look up Recipients in an Envelope Returns a list of recipients with a Recipient ID and Role Name in the given Docusign envelope.
Remove Recipient from Envelope Deletes a recipient from a Docusign envelope.
Send Adhoc Signature Request to User Sends a Docusign document associated with the specified ServiceNow record to the specified recipient for signature.
Send Adhoc Signature Request To Users - Inline Sends one or more uploaded documents from a ServiceNow record to multiple recipients.
Send Envelope Sends an envelope to the specified recipients.
Note: All recipient details must be provided before sending an envelope.
Set Field Value Sets the value of the specified field in the specified draft envelope.
Set Field Values Assigns the values of multiple fields associated to a document in a draft envelope.
Wait for Signature from Docusign Pauses a flow until the specified document has been signed or rejected. Returns the status of the document to the flow for further processing.
Group Management Add User To Group Adds user from a group.
Look up Group ID Retrieves a group ID for the specified role name.
Remove User From Group Removes the specified user from a group.
Template Management Look up Templates Per Account Retrieves the templates associated with the specified Docusign account.
Look up Template Fields Retrieves all fields in a template that is defined for a recipient.
Note:
  • Recipient ID used in this action is associated with the template and is different from the Recipient ID used in the Add Recipient to Envelope action.
  • Value of the Recipient ID is a unique system-generated number.
Look up Template Recipients Retrieves all recipients defined for a template.
User Management Create User Creates a Docusign user with the specified user details.
Look up User Detail Retrieves details for a user.
Update User Updates the specified user.
Delete User Deletes the specified Docusign user.

Spoke module

The Docusign eSignature spoke adds a Docusign module to your ServiceNow instance. The Docusign eSignature spoke synchronizes and stores templates and envelopes in ServiceNow. The Docusign eSignature spoke includes these tables and records.

Table/RecordDescription
Connection Aliases The Docusign connection alias.
Scheduled Job The Get Accounts & Templates scheduled job that synchronizes templates and envelopes with your Docusign account.
Accounts Docusign accounts synchronized with your ServiceNow instance. To synchronize accounts, see Synchronize Docusign with ServiceNow. The Get Accounts subflow retrieves a list of accounts and associated templates from Docusign and then inserts or updates them as records in the Accounts [sn_docusign_spoke_accounts] and Templates [sn_docusign_spoke_docusign_templates] tables.
Templates Docusign templates from synchronized Docusign accounts. The Get Templates Per Account subflow retrieves templates associated with a specified Docusign account and then inserts or updates them as records in the Templates [sn_docusign_spoke_docusign_templates] table.
Envelopes Docusign envelopes from synchronized Docusign accounts. Records in the Envelopes table are updated only when webhook is configured for the Docusign account.
DocuSign Webhook Answer Subflows List of webhook answer subflows.
The Docusign eSignature spoke tables include these fields.
Table Fields
Accounts [sn_docusign_spoke_accounts]
  • Account ID
  • Account Name
  • Description
  • Email
  • Alias
  • Display Name
Templates [sn_docusign_spoke_docusign_templates]
  • Account
  • Template ID
  • Name
  • Description
  • Last Modified
  • Display Name
Envelopes [sn_docusign_spoke_envelopes]
  • Account
  • ID
  • Status
  • Signed Date
  • Declined Reason
  • Display name
  • Embedded Signing
  • Signed Date Time Zone
  • Template

Spoke triggers

ServiceNow supports specific events on Docusign that create triggers. You must first configure a flow with a supported trigger definition. When an event, for example, a push request, occurs on the Docusign, it sends the payload via a webhook to the ServiceNow instance. After that, the flow that you configured is triggered at the ServiceNow instance to automate a workflow. The supported events are:

Category Trigger Definition
Envelope Management Envelope Completed Trigger is initiated when an envelope has been completed by all the recipients. Configure the flow to execute only when the specified trigger conditions are met.
Envelope Declined Trigger is initiated when an envelope has been declined by one of the recipients. Configure the flow to execute only when the specified trigger conditions are met.
Envelope Deleted Trigger is initiated when a sent envelope is deleted. Configure the flow to execute only when the specified trigger conditions are met.
Envelope Delivered Trigger is initiated when all recipients have opened the envelope through the Docusign signing website. Configure the flow to execute only when the specified trigger conditions are met.
Envelope Sent Trigger is initiated when an envelope is sent to recipient. Configure the flow to execute only when the specified trigger conditions are met.
Envelope Voided Trigger is initiated when an envelope has been voided by the sender or has expired. Configure the flow to execute only when the specified trigger conditions are met.
Recipient Management Recipient Completed Trigger is initiated when the recipient has completed their actions for the envelope. Configure the flow to execute only when the specified trigger conditions are met.
Recipient Declined Trigger is initiated when the recipient declines to sign the document(s) in the envelope. Configure the flow to execute only when the specified trigger conditions are met.
Recipient Delivered Trigger is initiated when the recipient has viewed the document(s) in an envelope through the Docusign signing web site. Configure the flow to execute only when the specified trigger conditions are met.
Recipient Sent Trigger is initiated when an email notification is sent to the recipient signifying that it is their turn to sign an envelope. Configure the flow to execute only when the specified trigger conditions are met.

For information about setting up the triggers for the Docusign eSignature spoke, see Set up triggers for the Docusign eSignature spoke. For more information about inbound integration, see Conditional and event-driven inbound integration.

Docusign account requirements

The Docusign eSignature spoke requires configuring your Docusign account to generate an OAuth 2.0 JWT Bearer Grant token.

Connection and credential alias requirements

Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.

This spoke uses the Docusign Connection & Credential Alias record to authorize actions.

Important:
  • You can choose to set up the Docusign spoke using authorization code grant or JWT grant.
    • Use Authorization Code Grant if your integration uses a browser or client to make requests to a web server.
    • Use JWT Grant if each user of your integration will use a single system account to log in.

    For more information about when to chose either of the setup methods, see Choose OAuth Type in Docusign Developer documentation.

  • Your company may have a Docusign account for each department that uses Docusign. To use multiple accounts with this spoke, create a child alias for each account. Also, ensure that you override the base alias with the child alias in your flows. At runtime, the system identifies the child alias associated with the account and sends the correct connection and credential information in the request.

    If your company only has one account, you can use the default Docusign alias provided with the spoke and proceed to setting up the Docusign spoke using authorization code grant or JWT grant.

MID Server requirements

These actions use REST calls that can run either on an instance or, optionally, through a MID Server. Use the connection record associated with the Docusign alias to configure where actions run and, if needed, specify MID Server selection attributes. For more information, see MID server.

To set up the MID Server for this spoke, see Set up MID Server for a spoke.