Skip to main content

DocuSign Component

Use the DocuSign component to manage signature collection and document distribution.

Component key: docusign

Changelog ↓

Description​

DocuSign is an electronic signature and digital transaction management platform. This component allows you to create and manage envelopes, send documents for signature, track signature status, manage templates, and configure webhooks for event notifications.

API Documentation​

This component was built using the DocuSign eSignature REST API Reference currently utilizing v2.1.

Connections​

DocuSign OAuth 2.0​

To connect to DocuSign using OAuth 2.0, a Developer Account is required to create integration applications.

Prerequisites​

Setup Steps​

  1. Log in to the DocuSign Developer Account
  2. Click on the profile icon in the top right corner and select My Apps & Keys
  3. Click Add App and Integration Key to create a new application
  4. Enter the required application details
  5. Under Redirect URIs in the Additional settings section, add the OAuth callback URL: https://oauth2.prismatic.io/callback
  6. Under the Secret Keys section, click Add Secret Key to generate a secret key
  7. Copy the Integration Key (Client ID) and the newly generated Secret Key (Client Secret)
  8. Click Save to save the application configuration

For more information on creating DocuSign integrations, refer to the DocuSign Developer Documentation.

Configure the Connection​

The DocuSign OAuth 2.0 connection requires the following fields:

  • Client ID (Integration Key): Enter the Integration Key from step 7
  • Client Secret (Secret Key): Enter the Secret Key from step 7
  • Authorization Header: This field requires a Base64-encoded value in the format Basic <encoded_credentials>

To create the Authorization Header value:

  1. Combine the Integration Key and Secret Key with a colon separator in the format: <integration_key>:<secret_key>

    • Example: 7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f:d7014634-xxxx-xxxx-xxxx-6842b7aa8861

  2. Encode this string to Base64 using one of the following methods:

    Option A: Using an online encoder

    • Navigate to a Base64 Encoder
    • Enter the combined key string in the format above
    • Click ENCODE
    • Copy the encoded result (e.g., NWMyYjhkN2.....hODg2MQ==)

    Option B: Using JavaScript

    • Open a JavaScript console and run: 
      btoa(
        "7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f:d7014634-xxxx-xxxx-xxxx-6842b7aa8861",
      );
    • Copy the returned Base64 string

  3. Enter the Authorization Header value as: Basic <base64_encoded_string>

    • Example: Basic NWMyYjhkN2.....hODg2MQ==

Verify Connection​

After configuring the connection, save the integration to authenticate with DocuSign. The OAuth flow will prompt for user authorization to complete the connection.

Developer vs Production Environments

DocuSign has separate environments for development and production. Developer accounts use the demo environment at account-d.docusign.com. For production environments, ensure the application is published and promoted in the DocuSign Admin Console. Refer to the DocuSign Go-Live documentation for more details.

InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for the API

https://account-d.docusign.com/oauth/auth
Integration Key

Integration Identifier of your app for the API

Secret Key

Secret Key of your app for the API

Authorization Header

You must supply an Authorization header to get a token. Key input value should be 'Authorization' and Headers value should be 'Basic <base64 encoded integration_key:secret_key>'

Scopessignature
Token URL

The OAuth 2.0 Token URL for the API

https://account-d.docusign.com/oauth/token
Use Live Environment

Use the live DocuSign API environment

false

Triggers​

Account Level Trigger​

Get notified when an event occurs at the account. | key: accountTrigger

InputNotesExample
Connection
Connect Key

This key is used to create the HMAC hash that DocuSign will send along with the message. Check https://developers.docusign.com/platform/webhooks/connect/setting-up-hmac/ for instructions on how to generate a key.

Webhook Event

The list of event types to subscribe to.

The Account Level Trigger can manage the DocuSign Connect webhook subscriptions for an instance. Unlike traditional webhook setups that require manual configuration in the DocuSign dashboard, this trigger handles the entire webhook lifecycle.

When the trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a Connect webhook configuration in the DocuSign account pointing to the instance's unique webhook URL. If a webhook with the same URL and events already exists, an error is thrown to prevent duplication.
  • On Instance Deletion: The trigger automatically removes the Connect webhook configuration from the DocuSign account.

HMAC Signature Verification​

This trigger uses HMAC signature verification to ensure that incoming webhook requests are genuine and originate from DocuSign. When DocuSign sends a webhook notification, it includes an x-docusign-signature header containing an HMAC hash of the payload.

The trigger validates this signature using the Connect Key configured in the trigger inputs. If the signature is invalid or missing, the webhook request is rejected. This prevents unauthorized parties from sending spoofed webhook notifications to the instance.

To obtain the Connect Key, navigate to the DocuSign Connect configuration in the DocuSign Admin Console. The Connect Key is used to generate the HMAC signature that DocuSign includes with each webhook request.

Event Types​

The trigger can be configured to listen for specific DocuSign events, including:

Envelope Events:

  • envelope-sent - An envelope has been sent to recipients
  • envelope-delivered - An envelope has been delivered to all recipients
  • envelope-completed - All recipients have completed the envelope
  • envelope-declined - A recipient has declined to sign the envelope
  • envelope-voided - The envelope has been voided

Recipient Events:

  • recipient-sent - A recipient has been sent the envelope
  • recipient-completed - A recipient has completed their action
  • recipient-declined - A recipient has declined the envelope
  • recipient-authenticationfailed - Recipient authentication has failed

Template Events:

  • template-created - A template has been created
  • template-modified - A template has been modified
  • template-deleted - A template has been deleted

Other Events:

  • click-agreed - A clickwrap agreement has been accepted
  • identity-verification-completed - Identity verification has been completed

For a complete list of available events and their payloads, refer to the DocuSign Webhook Event Triggers.

Configuration​

When configuring this trigger, the following inputs are required:

  1. Connection: The DocuSign OAuth 2.0 connection
  2. Connect Key: The HMAC secret key from the DocuSign Connect configuration
  3. Webhook Events: The specific event types to receive notifications for

The trigger will handle all webhook subscription management automatically when the instance is deployed or deleted.

Data Sources​

Select Folder​

Select a Folder. | key: folders | type: picklist

InputNotesExample
Connection
Count

The maximum number of results to return.

10
Include

A comma-separated list of folder types to include in the response. Valid values are: envelope_folders, template_folders and shared_template_folders.

envelope_folders
Include Items

When true, folder items are included in the response.

false
Start Position

The zero-based index of the result from which to start returning results.

0
Sub Folder Depth

If missing or any value other than -1, the returned list contains only the top-level folders. A value of -1 returns the complete folder hierarchy.

1
User Filter

Narrows down the resulting folder list by the following values: all, owned_by_me and shared_with_me.

all

Select Template​

Select a Template. | key: templates | type: picklist

InputNotesExample
Connection

Actions​

Create Account​

Creates a new DocuSign account. | key: createAccount

InputNotesExample
Account Name

The account name for the new account.

My Account Name
Address 1

The first line of the address. Maximum length: 100 characters.

123 Main St
Address 2

The second line of the address. Maximum length: 100 characters.

Suite 100
City

The city associated with the address. Maximum length: 40 characters.

San Francisco
Company

The name of the user's company.

Acme Corporation
Connection
Country

The country associated with the address. Maximum length: 50 characters.

United States
Distributor Code

The Distributor Code that you received from DocuSign.

DEVCENTER_DEMO_APRIL2013
Distributor Password

The password for the Distributor Code.

Email

The user's email address.

john.doe@example.com
Fax

The fax number associated with the account.

+1-555-123-4567
First Name

The user's first name. Maximum Length: 50 characters.

John
Included Seats

The number of seats (users) included in the plan.

10
Job Title

The user's job title.

Software Engineer
Last Name

The user's last name. Maximum Length: 50 characters.

Doe
Middle Name

The user's middle name. Maximum Length: 50 characters.

Jacob
Phone

The phone number associated with the account.

+1-555-123-4567
Plan ID

DocuSign's ID for the account plan.

Postal Code

The postal code associated with the address. Maximum length: 20 characters.

94105
Referral Code

The referral code associated with the account.

Referrer Name

The name of the referrer.

State

The state or province associated with the address. Maximum length: 40 characters.

California
Suffix Name

The suffix for the user's name. Maximum Length: 50 characters.

Jr.
User Name

The name of the user.

John Doe

Create Account Signature​

Adds or updates one or more account stamps. | key: createAccountSignature

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/createaccountsignatures/

Create Bulk Send List​

This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once. | key: createBulkSendList

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/

Create Contact​

This method adds multiple contacts into a contacts list. | key: createContact

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/create/

{
  "data": {
    "contactId": "e0f1a2b3-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
    "name": "Sarah Miller",
    "email": "sarah.miller@example.com",
    "organization": "Miller Associates",
    "shared": "false",
    "createdDateTime": "2025-01-15T13:00:00.000Z"
  }
}

Create Envelope​

Creates and sends an envelope or creates a draft envelope. | key: createEnvelope

InputNotesExample
Change Routing Order

When true, allows defining the routing order of recipients while sending documents for signature.

false
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/

Merge Roles On Draft

When true, template roles will be merged and empty recipients will be removed. This parameter applies when creating a draft envelope with multiple templates.

false

{
  "data": {
    "envelopeId": "a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "uri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "statusDateTime": "2025-01-15T10:30:45.123Z",
    "status": "sent"
  }
}

Create Template​

Creates one or more template definitions, using a multipart request for each template. | key: createTemplate

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/

{
  "data": {
    "templateId": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "name": "Standard NDA Template",
    "shared": "false",
    "description": "Non-Disclosure Agreement template for partners",
    "created": "2025-01-15T10:00:00.000Z",
    "lastModified": "2025-01-15T10:00:00.000Z",
    "lastModifiedBy": {
      "userName": "John Doe",
      "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
      "email": "john.doe@example.com",
      "userType": "CompanyUser",
      "userStatus": "Active"
    },
    "pageCount": 5,
    "folderName": "Templates",
    "folderId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
  }
}

Create Webhook​

Create a new webhook (Account Level). | key: createWebhook

InputNotesExample
Connection
Include HMAC

When true, the HMAC hash is included in the message along with the API request.

false
URL To Publish To

The URL that DocuSign will publish events to.

https://your-webhook-endpoint.com/webhook
Webhook Event

The list of event types to subscribe to.

Connect (Webhook) Configuration Name

A name for the configuration.

My Webhook Configuration

{
  "data": {
    "connectId": "c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
    "configurationType": "custom",
    "urlToPublishTo": "https://example.com/webhooks/docusign",
    "name": "My Integration Webhook",
    "allowEnvelopePublish": "true",
    "enableLog": "true",
    "requiresAcknowledgement": "true",
    "signMessageWithX509Certificate": "false",
    "useSoapInterface": "false",
    "includeHMAC": "true",
    "includeDocumentFields": "true",
    "includeSenderAccountAsCustomField": "true",
    "includeTimeZone": "true",
    "includeEnvelopeVoidReason": "true",
    "includeDocuments": "false",
    "allUsers": "true",
    "events": [
      "envelope-sent",
      "envelope-delivered",
      "envelope-completed",
      "envelope-declined",
      "envelope-voided",
      "recipient-sent",
      "recipient-delivered",
      "recipient-completed",
      "recipient-declined"
    ],
    "eventData": {
      "version": "restv2.1",
      "includeData": [
        "documents",
        "recipients",
        "custom_fields"
      ],
      "format": "json"
    },
    "deliveryMode": "SIM",
    "soapNameSpace": null,
    "createdDateTime": "2025-01-15T10:45:00.000Z"
  }
}

Delete Account​

Closes the specified account. | key: deleteAccount

InputNotesExample
Account ID

The external account number (int) or account ID GUID.

23233123
Connection

Delete Account Signature​

Deletes a stamp specified by signatureId. | key: deleteAccountSignature

InputNotesExample
Account ID

The external account number (int) or account ID GUID.

23233123
Connection
Signature ID

The unique identifier of the signature.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f

Delete All Instanced Webhooks​

Delete all webhooks that point to a flow in this instance. | key: deleteAllInstancedWebhooks

InputNotesExample
Connection

Delete Bulk Send List​

This method deletes a bulk send list. | key: deleteBulkSendList

InputNotesExample
Bulk Send List ID

The GUID of the bulk send list. This property is created after you post a new bulk send list.

d6f6a764-1021-43df-b8db-06c5477dd28a
Connection

Delete Contact​

This method deletes a contact associated with an account. | key: deleteContact

InputNotesExample
Connection
Contact ID

The ID of a contact person in the account's address book.

Delete Envelope Document​

Deletes one or more documents from an existing envelope that has not yet been completed. | key: deleteEnvelopeDocument

InputNotesExample
Connection
Document IDs

A list of document IDs to delete.

["1", "2", "3"]
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a

{
  "data": {
    "envelopeId": "a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "deleted",
    "deletedDateTime": "2025-01-15T17:00:00.000Z"
  }
}

Delete Template Document​

This method deletes one or more documents from an existing template. | key: deleteTemplateDocument

InputNotesExample
Connection
Document IDs

A list of document IDs to delete.

["1", "2", "3"]
Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

Delete User​

Closes one or more users in the account, preventing them from accessing account features. | key: deleteUser

InputNotesExample
Connection
Delete

A list of groups to remove the user from. A comma-separated list of the following: Groups, PermissionSet or SigningGroupsEmail.

Groups
User IDs

A list of user IDs to delete.

["a1b5f946-2351-4380-b24e-297e8c708a67"]

Delete Webhook​

Delete a single webhook. | key: deleteWebhook

InputNotesExample
Connect ID

The ID of the custom Connect (Webhook) configuration to delete.

10486941
Connection

{
  "data": {
    "connectId": "c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
    "status": "deleted"
  }
}

Get Account​

Retrieves the account information for the specified account. | key: getAccount

InputNotesExample
Account ID

The external account number (int) or account ID GUID.

23233123
Connection

{
  "data": {
    "accountId": "7654321",
    "accountIdGuid": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
    "accountName": "Example Corporation",
    "allowTransactionRooms": "true",
    "billingPeriodDaysRemaining": "28",
    "billingPeriodEndDate": "2025-02-15",
    "billingPeriodEnvelopesAllowed": "5000",
    "billingPeriodEnvelopesSent": "1234",
    "billingPeriodStartDate": "2025-01-15",
    "billingProfile": "Professional",
    "canCancelRenewal": "true",
    "canUpgrade": "true",
    "connectPermission": "full",
    "createdDate": "2020-03-15",
    "currencyCode": "USD",
    "currentPlanId": "bfdf6b72-c0cb-4e92-ba26-27d1ff97d968",
    "distributorCode": "none",
    "envelopeSendingBlocked": "false",
    "envelopeUnitPrice": "0.50",
    "isDowngrade": "false",
    "planClassification": "corporate",
    "planName": "DocuSign Business Pro",
    "planStartDate": "2020-03-15",
    "seatsAllowed": "25",
    "seatsInUse": "18",
    "status": "active",
    "suspensionDate": null,
    "suspensionStatus": null
  }
}

Get Account Signature​

Returns information about the specified stamp. | key: getAccountSignature

InputNotesExample
Connection
Signature ID

The unique identifier of the signature.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f

Get Account Signature Image​

Returns the image for an account stamp. | key: getAccountSignatureImage

InputNotesExample
Connection
Image Type

Specifies the type of image.

Signature ID

The unique identifier of the signature.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f

Get Bulk Send Batches​

Returns a summary of bulk send batches. | key: getBulkSendBatches

InputNotesExample
Connection

Get Bulk Send List​

This method returns all of the details associated with a specific bulk send list that belongs to the current user. | key: getBulkSendList

InputNotesExample
Bulk Send List ID

The GUID of the bulk send list. This property is created after you post a new bulk send list.

d6f6a764-1021-43df-b8db-06c5477dd28a
Connection

Get Bulk Send Lists​

This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list. | key: getBulkSendLists

InputNotesExample
Connection

Get Bulk Send Status​

Gets the general status of a specific bulk send batch. | key: getBulkSendBatchStatus

InputNotesExample
Bulk Send Batch ID

The batch ID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Connection

Get Contact​

This method returns one or more contacts associated with a DocuSign account. | key: getContact

InputNotesExample
Cloud Provider

The cloud provider from which to retrieve the contacts. Valid values are: rooms or docusignCore.

rooms
Connection
Contact ID

The ID of a contact person in the account's address book.

{
  "data": {
    "contactId": "e0f1a2b3-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
    "name": "Sarah Miller",
    "email": "sarah.miller@example.com",
    "organization": "Miller Associates",
    "cloudProvider": null,
    "cloudProviderContainerId": null,
    "signingGroup": null,
    "signingGroupName": null,
    "shared": "false",
    "isOwner": "true",
    "owner": {
      "userName": "John Doe",
      "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
      "email": "john.doe@example.com"
    },
    "createdDateTime": "2025-01-15T13:00:00.000Z"
  }
}

Get Envelope​

Retrieves the overall status for the specified envelope. | key: getEnvelope

InputNotesExample
Advanced Update

When true, allows advanced update operations for the document.

false
Connection
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Include

Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients.

envelope_folders

{
  "data": {
    "envelopeId": "a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "sent",
    "documentsUri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/documents",
    "recipientsUri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/recipients",
    "attachmentsUri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/attachments",
    "envelopeUri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "emailSubject": "Please sign the NDA",
    "emailBlurb": "Please review and sign the attached NDA document.",
    "envelopeIdStamping": "true",
    "enableWetSign": "true",
    "allowMarkup": "false",
    "allowReassign": "true",
    "createdDateTime": "2025-01-15T10:30:45.123Z",
    "sentDateTime": "2025-01-15T10:30:50.456Z",
    "statusChangedDateTime": "2025-01-15T10:30:50.456Z",
    "recipients": {
      "signers": [
        {
          "recipientId": "1",
          "recipientIdGuid": "b4c3d2e1-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
          "name": "Jane Doe",
          "firstName": "Jane",
          "lastName": "Doe",
          "email": "jane.doe@example.com",
          "roleName": "Signer",
          "routingOrder": "1",
          "status": "sent",
          "deliveryMethod": "email",
          "tabs": {
            "signHereTabs": [
              {
                "tabId": "c5d4e3f2-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
                "tabLabel": "signer1sig",
                "name": "Please sign here",
                "documentId": "1",
                "recipientId": "1",
                "pageNumber": "1",
                "xPosition": "100",
                "yPosition": "200",
                "optional": "false",
                "anchorString": "signer1sig",
                "anchorXOffset": "0",
                "anchorYOffset": "0",
                "anchorUnits": "pixels",
                "status": "active"
              }
            ],
            "dateSignedTabs": [
              {
                "tabId": "d6e5f4a3-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
                "tabLabel": "date_signed",
                "name": "Date Signed",
                "documentId": "1",
                "recipientId": "1",
                "pageNumber": "1",
                "xPosition": "100",
                "yPosition": "250",
                "anchorString": "signer1date",
                "anchorYOffset": "-6",
                "fontSize": "Size12",
                "status": "active"
              }
            ]
          }
        }
      ],
      "carbonCopies": [],
      "certifiedDeliveries": []
    },
    "documents": [
      {
        "documentId": "1",
        "documentIdGuid": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
        "name": "NDA.pdf",
        "type": "content",
        "uri": "/envelopes/a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/documents/1",
        "order": "1",
        "pages": "5",
        "display": "inline",
        "includeInDownload": "true",
        "fileExtension": "pdf",
        "documentFields": []
      }
    ],
    "customFields": {
      "textCustomFields": [],
      "listCustomFields": []
    },
    "notification": {
      "useAccountDefaults": "false",
      "reminders": {
        "reminderEnabled": "true",
        "reminderDelay": "2",
        "reminderFrequency": "2"
      },
      "expirations": {
        "expireEnabled": "true",
        "expireAfter": "120",
        "expireWarn": "20"
      }
    },
    "signingLocation": "online",
    "authoritativeCopy": "false",
    "enforceSignerVisibility": "false",
    "is21CFRPart11": "false"
  }
}

Get Envelope Document​

Retrieves a single document or all documents from an envelope. | key: getEnvelopeDocument

InputNotesExample
Certificate

When true, the certificate of completion is included in the combined PDF.

false
Connection
Document ID

The ID of the document to retrieve.

1
Documents By User ID

When true, allows recipients to get documents by their user ID.

false
Encrypt

When true, the PDF bytes returned in the response are encrypted for all key managers configured on your DocuSign account.

false
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Language

Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).

en
Recipient ID

Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.

3842784d-ef49-43e0-8c9c-714812a90ddd
Shared User ID

The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.

3842784d-ef49-43e0-8c9c-714812a90ddd
Show Changes

When true, any changed fields in the returned PDF are highlighted in yellow and optional signatures or initials are outlined in red. The account must have the Highlight Data Changes feature enabled.

false
Watermark

When true, and the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

false

Get Recipient Signature​

Retrieves signature information for a signer or sign-in-person recipient. | key: getRecipientSignature

InputNotesExample
Connection
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Recipient ID

A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.

3842784d-ef49-43e0-8c9c-714812a90ddd

Get Recipient Signature Image​

Retrieves the specified user signature image. | key: getRecipientSignatureImage

InputNotesExample
Connection
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Include Chrome

When true, the response includes the chrome-styled version of the signature image.

false
Recipient ID

A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.

3842784d-ef49-43e0-8c9c-714812a90ddd

Get Template​

Retrieves the definition of the specified template. | key: getTemplate

InputNotesExample
Connection
Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

{
  "data": {
    "templateId": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "name": "Standard NDA Template",
    "shared": "false",
    "description": "Non-Disclosure Agreement template for partners",
    "created": "2025-01-15T10:00:00.000Z",
    "lastModified": "2025-01-15T10:00:00.000Z",
    "lastModifiedBy": {
      "userName": "John Doe",
      "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
      "email": "john.doe@example.com",
      "userType": "CompanyUser",
      "userStatus": "Active",
      "uri": "/users/f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c"
    },
    "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "pageCount": 5,
    "folderName": "Templates",
    "folderId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "folderUri": "/folders/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "owner": {
      "userName": "John Doe",
      "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
      "email": "john.doe@example.com",
      "userType": "CompanyUser",
      "userStatus": "Active"
    },
    "documents": [
      {
        "documentId": "1",
        "name": "NDA.pdf",
        "type": "content",
        "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b/documents/1",
        "order": "1",
        "pages": "5",
        "fileExtension": "pdf",
        "display": "inline",
        "includeInDownload": "true"
      }
    ],
    "recipients": {
      "signers": [
        {
          "recipientId": "1",
          "roleName": "Signer",
          "routingOrder": "1",
          "name": "Signer 1",
          "email": null,
          "tabs": {
            "signHereTabs": [
              {
                "tabLabel": "signer1sig",
                "name": "Signature",
                "documentId": "1",
                "recipientId": "1",
                "pageNumber": "1",
                "xPosition": "100",
                "yPosition": "200",
                "anchorString": "signer1sig",
                "anchorXOffset": "0",
                "anchorYOffset": "0",
                "anchorUnits": "pixels"
              }
            ]
          }
        }
      ],
      "carbonCopies": [],
      "certifiedDeliveries": []
    },
    "emailSubject": "Please sign this document",
    "emailBlurb": "Please review and sign the attached document.",
    "status": "created"
  }
}

Get Template Document​

This method retrieves one or more PDF documents from the template that you specify. | key: getTemplateDocument

InputNotesExample
Connection
Document ID

The ID of the document to retrieve.

1
Encrypt

When true, the PDF bytes returned in the response are encrypted for all key managers configured on your DocuSign account.

false
File Type

The type of file to retrieve.

Show Changes

When true, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.

false
Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

Get User​

Retrieves the user information for the specified user. | key: getUser

InputNotesExample
Connection
User ID

The ID of the user to access.

a1b5f946-2351-4380-b24e-297e8c708a67

{
  "data": {
    "userId": "a0b1c2d3-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "userName": "Alice Johnson",
    "email": "alice.johnson@example.com",
    "firstName": "Alice",
    "lastName": "Johnson",
    "middleName": null,
    "suffixName": null,
    "title": "Senior Engineer",
    "userStatus": "Active",
    "userType": "CompanyUser",
    "isAdmin": "false",
    "uri": "/users/a0b1c2d3-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
    "createdDateTime": "2025-01-15T10:30:00.000Z",
    "lastLogin": "2025-01-20T09:15:30.000Z",
    "permissionProfileId": "b1c2d3e4-5f6a-7b8c-9d0e-1f2a3b4c5d6e",
    "permissionProfileName": "DocuSign Sender",
    "activationAccessCode": null,
    "loginStatus": "active",
    "userSettings": [
      {
        "name": "canSendEnvelope",
        "value": "true"
      },
      {
        "name": "canSendAPIRequests",
        "value": "true"
      }
    ],
    "groupList": [],
    "workAddress": {
      "address1": "123 Main Street",
      "address2": "Suite 400",
      "city": "San Francisco",
      "stateOrProvince": "CA",
      "postalCode": "94105",
      "phone": "+1-555-123-4567",
      "fax": null,
      "country": "US"
    },
    "homeAddress": null
  }
}

Get Webhook​

Retrieve a single webhook. | key: getWebhook

InputNotesExample
Connect ID

The ID of the custom Connect (Webhook) configuration being accessed.

10486941
Connection

{
  "data": {
    "connectId": "c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
    "configurationType": "custom",
    "urlToPublishTo": "https://example.com/webhooks/docusign",
    "name": "My Integration Webhook",
    "allowEnvelopePublish": "true",
    "enableLog": "true",
    "requiresAcknowledgement": "true",
    "signMessageWithX509Certificate": "false",
    "useSoapInterface": "false",
    "includeHMAC": "true",
    "includeDocumentFields": "true",
    "includeSenderAccountAsCustomField": "true",
    "includeTimeZone": "true",
    "includeEnvelopeVoidReason": "true",
    "includeDocuments": "false",
    "allUsers": "true",
    "events": [
      "envelope-sent",
      "envelope-delivered",
      "envelope-completed",
      "envelope-declined",
      "envelope-voided",
      "recipient-sent",
      "recipient-delivered",
      "recipient-completed",
      "recipient-declined"
    ],
    "eventData": {
      "version": "restv2.1",
      "includeData": [
        "documents",
        "recipients",
        "custom_fields"
      ],
      "format": "json"
    },
    "deliveryMode": "SIM",
    "soapNameSpace": null,
    "createdDateTime": "2025-01-15T10:45:00.000Z",
    "failureDetails": null
  }
}

List Account Settings​

Retrieves the account settings information for the specified account. | key: listAccountSettings

InputNotesExample
Account ID

The external account number (int) or account ID GUID.

23233123
Connection

{
  "data": {
    "accountSettings": [
      {
        "name": "allowEnvelopePublish",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      },
      {
        "name": "allowExpressSignerCertificate",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      },
      {
        "name": "allowSignerReassign",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      },
      {
        "name": "allowSigningExtensions",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      },
      {
        "name": "enableAutoNav",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      },
      {
        "name": "enableDSPro",
        "value": "true",
        "type": "Boolean",
        "canModify": "false"
      },
      {
        "name": "envelopeIntegrationAllowed",
        "value": "full",
        "type": "String",
        "canModify": "false"
      },
      {
        "name": "useConsumerDisclosure",
        "value": "true",
        "type": "Boolean",
        "canModify": "true"
      }
    ]
  }
}

List Envelope Documents​

Retrieves a list of documents associated with the specified envelope. | key: listEnvelopeDocuments

InputNotesExample
Connection
Documents By User ID

When true, allows recipients to get documents by their user ID.

false
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
Include Metadata

When true, the response includes metadata indicating which properties the sender can edit.

false
Include Tabs

When true, information about the tabs, including prefill tabs, associated with the documents is included in the response.

false
Recipient ID

Allows the sender to retrieve the documents as one of the recipients that they control. The documents_by_userid parameter must be set to false for this to work.

3842784d-ef49-43e0-8c9c-714812a90ddd
Shared User ID

The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents.

3842784d-ef49-43e0-8c9c-714812a90ddd

List Folder Items​

Gets information about items in the specified folder. | key: listFolderItems

InputNotesExample
Connection
Folder ID

The ID of the folder.

d6f6a764-1021-43df-b8db-06c5477dd28a
Include Items

When true, folder items are included in the response.

false

List Folders​

Returns a list of the account's folders. | key: listFolders

InputNotesExample
Connection
Count

The maximum number of results to return.

10
Include

A comma-separated list of folder types to include in the response. Valid values are: envelope_folders, template_folders and shared_template_folders.

envelope_folders
Include Items

When true, folder items are included in the response.

false
Start Position

The zero-based index of the result from which to start returning results.

0
Sub Folder Depth

If missing or any value other than -1, the returned list contains only the top-level folders. A value of -1 returns the complete folder hierarchy.

1
User Filter

Narrows down the resulting folder list by the following values: all, owned_by_me and shared_with_me.

all

List Template Documents​

Retrieves a list of documents associated with the specified template. | key: listTemplateDocuments

InputNotesExample
Connection
Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

{
  "data": {
    "templateId": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "templateDocuments": [
      {
        "documentId": "1",
        "name": "NDA.pdf",
        "type": "content",
        "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b/documents/1",
        "order": "1",
        "pages": "5",
        "fileExtension": "pdf",
        "display": "inline",
        "includeInDownload": "true"
      },
      {
        "documentId": "2",
        "name": "Appendix A.pdf",
        "type": "content",
        "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b/documents/2",
        "order": "2",
        "pages": "3",
        "fileExtension": "pdf",
        "display": "inline",
        "includeInDownload": "true"
      }
    ]
  }
}

List Templates​

Retrieves the list of templates for the specified account. | key: listTemplates

InputNotesExample
Connection

{
  "data": {
    "resultSetSize": "10",
    "startPosition": "0",
    "endPosition": "9",
    "totalSetSize": "25",
    "nextUri": "/templates?start_position=10",
    "previousUri": null,
    "envelopeTemplates": [
      {
        "templateId": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
        "name": "Standard NDA Template",
        "shared": "false",
        "description": "Non-Disclosure Agreement template for partners",
        "created": "2025-01-15T10:00:00.000Z",
        "lastModified": "2025-01-15T10:00:00.000Z",
        "pageCount": 5,
        "uri": "/templates/e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
        "folderName": "Templates",
        "folderId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "owner": {
          "userName": "John Doe",
          "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
          "email": "john.doe@example.com"
        }
      },
      {
        "templateId": "f9a8b7c6-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
        "name": "Employment Contract Template",
        "shared": "false",
        "description": "Standard employment contract template",
        "created": "2025-01-10T14:20:00.000Z",
        "lastModified": "2025-01-12T09:15:00.000Z",
        "pageCount": 12,
        "uri": "/templates/f9a8b7c6-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
        "folderName": "HR Templates",
        "folderId": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
        "owner": {
          "userName": "John Doe",
          "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
          "email": "john.doe@example.com"
        }
      }
    ],
    "folders": [
      {
        "folderId": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "name": "Templates",
        "type": "templates",
        "uri": "/folders/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
      },
      {
        "folderId": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
        "name": "HR Templates",
        "type": "templates",
        "uri": "/folders/b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
      }
    ]
  }
}

List Webhooks​

Retrieve all webhooks. | key: listWebhooks

InputNotesExample
Connection

{
  "data": {
    "totalRecords": "3",
    "configurations": [
      {
        "connectId": "c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
        "configurationType": "custom",
        "urlToPublishTo": "https://example.com/webhooks/docusign",
        "name": "My Integration Webhook",
        "allowEnvelopePublish": "true",
        "enableLog": "true",
        "includeHMAC": "true",
        "allUsers": "true",
        "events": [
          "envelope-sent",
          "envelope-completed",
          "recipient-completed"
        ],
        "createdDateTime": "2025-01-15T10:45:00.000Z"
      },
      {
        "connectId": "d3e4f5a6-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
        "configurationType": "custom",
        "urlToPublishTo": "https://example.com/webhooks/backup",
        "name": "Backup Webhook",
        "allowEnvelopePublish": "true",
        "enableLog": "true",
        "includeHMAC": "true",
        "allUsers": "true",
        "events": [
          "envelope-voided",
          "envelope-declined"
        ],
        "createdDateTime": "2025-01-10T14:20:00.000Z"
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to DocuSign. | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/ACCOUNT_ID/folders), The base URL is already included (https://account.docusign.com for live environment or https://account-d.docusign.com for development). For example, to connect to https://account.docusign.com/ACCOUNT_ID/folders, only /ACCOUNT_ID/folders is entered in this field.

/ACCOUNT_ID/folders
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Update Account Signature​

Updates an account stamp specified by the signatureId query parameter. | key: updateAccountSignature

InputNotesExample
Connection
Date Area Height

The height of the rectangle.

50
Date Area Width

The width of the rectangle.

100
Date Area X

The X axis position of the top-left corner.

0
Date Area Y

The Y axis position of the top-left corner.

0
Disallow User Resize Stamp

When true, prevents the user from resizing the stamp.

false
External ID

Optionally specify an external identifier for the user's signature.

Image Type

Specifies the type of image.

Is Default

When true, specifies that the signature is the default signature for the user.

false
NRDS ID

The National Association of Realtors (NAR) membership ID for a user who is a realtor.

123456789
NRDS Last Name

The last name of the user who is a realtor.

Doe
Phonetic Name

The phonetic spelling of the signatureName.

Signature Font

The font type to use for the signature if the signature is not drawn.

Signature Groups

A JSON array of signature groups.

Signature ID

Specifies the signature ID associated with the signature name.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f
Signature ID

Signature ID to update.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f
Signature Initials

Specifies the user's signature in initials format.

JD
Signature Name

Specifies the user's signature name.

John Doe
Signature Type

The type of signature. Check this link for more information: https://support.docusign.com/s/document-item?language=en_US&bundleId=xcm1643837555908&topicId=url1578456563691.html

Electronic Signature
Signature Users

JSON array of users associated with the signature.

Stamp Format

NameHanko refers to the stamp that displays only the name of the signer. On the other hand, NameDateHanko refers to the stamp that displays both the name and date.

Stamp Size MM

The size of the stamp in millimeters.

10

Update Account Signature Image​

Sets a signature image, initials, or stamp. | key: updateAccountSignatureImage

InputNotesExample
Connection
Image Type

Specifies the type of image.

Signature ID

The ID of the account stamp.

f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f

Update Bulk Send List​

This method replaces the definition of an existing bulk send list. | key: updateBulkSendList

InputNotesExample
Bulk Send List ID

The GUID of the bulk send list. This property is created after you post a new bulk send list.

d6f6a764-1021-43df-b8db-06c5477dd28a
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/updatebulksendlist/

Update Contact​

This method updates one or more contacts associated with an account. | key: updateContact

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/update/

Update Envelope​

This method enables you to make changes to an envelope. | key: updateEnvelope

InputNotesExample
Advanced Update

When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.

false
Connection
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/

Resend Envelope

When true, resends the specified envelope.

false

{
  "data": {
    "envelopeId": "a3b2c1d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "voided",
    "voidedDateTime": "2025-01-15T16:30:00.000Z",
    "voidedReason": "Requested by sender",
    "statusChangedDateTime": "2025-01-15T16:30:00.000Z"
  }
}

Update Envelope Document​

Adds or replaces a document in an existing draft or in-process envelope. | key: updateEnvelopeDocument

InputNotesExample
Connection
Document ID

The unique ID of the document within the envelope.

1
Document Name

The name of the document.

Contract.pdf
Envelope ID

The envelope's GUID.

d6f6a764-1021-43df-b8db-06c5477dd28a
PDF data

This must refer to a buffer containing the raw bytes of a PDF.

Update Template​

Updates an existing template. | key: updateTemplate

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/update/

Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

{
  "data": {
    "templateId": "e7f6a5b4-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
    "name": "Updated NDA Template",
    "description": "Updated Non-Disclosure Agreement template",
    "lastModified": "2025-01-15T16:30:00.000Z",
    "lastModifiedBy": {
      "userName": "John Doe",
      "userId": "f8a7b6c5-0d1e-2f3a-4b5c-6d7e8f9a0b1c",
      "email": "john.doe@example.com"
    }
  }
}

Update Template Document​

This methods updates an existing template document. | key: updateTemplateDocument

InputNotesExample
Connection
Document ID

The ID of the document to retrieve.

1
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/

Template ID

The ID of the template.

d6f6a764-1021-43df-b8db-06c5477dd28a

Update User​

To update user information for a specific user, submit a Users object with updated field values in the request body of this operation. | key: updateUser

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/users/users/update/

User ID

The ID of the user to access.

a1b5f946-2351-4380-b24e-297e8c708a67

Update Webhook​

Update an existing webhook. | key: updateWebhook

InputNotesExample
Connection
JSON Input

For extra fields, see https://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/update/

{
  "data": {
    "connectId": "c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
    "configurationType": "custom",
    "urlToPublishTo": "https://example.com/webhooks/docusign-updated",
    "name": "Updated Integration Webhook",
    "allowEnvelopePublish": "true",
    "enableLog": "true",
    "includeHMAC": "true",
    "lastModifiedDateTime": "2025-01-20T09:30:00.000Z"
  }
}

Changelog​

2025-10-22​

Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup.