![docusign icon](/docs/img/components/icons/60/ZG9jdXNpZ24=.png) # DocuSign Connector key: docusign[Source](https://github.com/prismatic-io/components/tree/main/components/docusign)[API Docs](https://developers.docusign.com/docs/esign-rest-api/)[API Changelog](https://developers.docusign.com/changelog/)[Connector Changelog](#changelog) ## Description[​](#description "Direct link to Description") [DocuSign](https://www.docusign.com/) 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[​](#api-documentation "Direct link to API Documentation") This component was built using the [DocuSign eSignature REST API Reference](https://developers.docusign.com/docs/esign-rest-api/reference/) currently utilizing v2.1. ## Connections[​](#connections "Direct link to Connections") ### OAuth 2.0[​](#docusignoauthconnection "Direct link to OAuth 2.0") **key: docusignOauthConnection** To connect to DocuSign using OAuth 2.0, a Developer Account is required to create integration applications. #### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A [DocuSign Developer Account](https://developers.docusign.com/) is required * Access to the DocuSign Admin Console #### Setup Steps[​](#setup-steps "Direct link to Setup Steps") 1. Log in to the [DocuSign Developer Account](https://developers.docusign.com/auth/docusign-demo/) 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](https://developers.docusign.com/docs/esign-rest-api/esign101/auth/). #### Configure the Connection[​](#configure-the-connection "Direct link to 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 ` To create the Authorization Header value: 1. Combine the Integration Key and Secret Key with a colon separator in the format: `:` * 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](https://www.base64encode.org/) * 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: ```javascript btoa( "7c2b8d7e-xxxx-xxxx-xxxx-cda8a50dd73f:d7014634-xxxx-xxxx-xxxx-6842b7aa8861", ); ``` * Copy the returned Base64 string 3. Enter the **Authorization Header** value as: `Basic ` * Example: `Basic NWMyYjhkN2.....hODg2MQ==` #### Verify Connection[​](#verify-connection "Direct link to 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. #### Going Live[​](#going-live "Direct link to Going Live") DocuSign requires apps created in the developer environment to complete a Go-Live review before they can access real production accounts. This process verifies the integration is production-ready and meets DocuSign's requirements for handling legally binding signature workflows. DocuSign apps pass through two states before they are ready for deployment. **Developer environment (before Go-Live):** Users can authenticate and the OAuth flow completes normally, but the integration connects to `account-d.docusign.com`. Only demo accounts and test documents are accessible. No real production DocuSign accounts or live documents can be reached. This is the expected state during development and testing. **Production (after Go-Live):** The integration connects to `account.docusign.com`. Users authenticate with their real DocuSign credentials and live documents and accounts are fully accessible. **Complete the Go-Live process before deploying to end users.** DocuSign apps created in the developer account connect to the demo environment (`account-d.docusign.com`). Until Go-Live is approved, the integration cannot access real production DocuSign accounts. #### Go-Live Requirements[​](#go-live-requirements "Direct link to Go-Live Requirements") * The app must make at least 20 API calls in the demo environment to demonstrate functional testing before Go-Live is available #### Go-Live Process[​](#go-live-process "Direct link to Go-Live Process") 1. Log in to the [DocuSign Developer Account](https://developers.docusign.com/auth/docusign-demo/) 2. Navigate to **My Apps & Keys** and select the application 3. Click **Go Live** to submit the application for production access 4. DocuSign reviews the application. Reviews typically complete within 3 business days 5. Once approved, the application is promoted to the production environment #### Production Endpoints[​](#production-endpoints "Direct link to Production Endpoints") After Go-Live approval, update the integration to connect to production endpoints: * **Authorization URL**: `https://account.docusign.com/oauth/auth` * **Token URL**: `https://account.docusign.com/oauth/token` * **API Base URL**: `https://www.docusign.net/restapi` The demo environment uses `account-d.docusign.com`. Ensure URLs are updated to production endpoints after Go-Live. For detailed Go-Live requirements, refer to the [DocuSign Go-Live documentation](https://developers.docusign.com/docs/esign-rest-api/go-live/). | Input | Notes | Example | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | 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 \' | | | Scopes | | signature | | 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[​](#triggers "Direct link to Triggers") ### Account Level Trigger[​](#accounttrigger "Direct link to Account Level Trigger") Get notified when an event occurs at the account. | **key: accountTrigger** | Input | Notes | Example | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | 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 manages [DocuSign Connect webhook subscriptions](https://developers.docusign.com/platform/webhooks/connect/) for an instance. Unlike traditional webhook setups that require manual configuration in the DocuSign dashboard, this trigger handles the entire webhook lifecycle automatically. #### How It Works[​](#how-it-works "Direct link to How It Works") When this 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 already exists, an error is thrown to prevent duplication. * **On Instance Deletion**: The trigger automatically removes the Connect webhook configuration from the DocuSign account. 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. For details on generating an HMAC key, refer to the [DocuSign HMAC setup guide](https://developers.docusign.com/platform/webhooks/connect/setting-up-hmac/). #### Configuration[​](#configuration "Direct link to Configuration") 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, used to verify incoming webhook signatures 3. **Webhook Events**: The specific event types to receive notifications for #### Event Types[​](#event-types "Direct link to Event Types") Available Events (29) | Event | Description | | --------------------------------- | ------------------------------------------------ | | `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-created` | An envelope has been created | | `envelope-declined` | A recipient has declined to sign the envelope | | `envelope-voided` | The envelope has been voided | | `envelope-resent` | An envelope has been resent | | `envelope-corrected` | An envelope has been corrected | | `envelope-purge` | An envelope has been purged | | `envelope-deleted` | An envelope has been deleted | | `envelope-discard` | An envelope has been discarded | | `recipient-sent` | A recipient has been sent the envelope | | `recipient-autoresponded` | A recipient has auto-responded | | `recipient-delivered` | A recipient has received the envelope | | `recipient-completed` | A recipient has completed their action | | `recipient-declined` | A recipient has declined the envelope | | `recipient-authenticationfailed` | Recipient authentication has failed | | `recipient-resent` | The envelope has been resent to a recipient | | `recipient-delegate` | A recipient has delegated their action | | `recipient-reassign` | A recipient has been reassigned | | `recipient-finish-later` | A recipient has chosen to finish later | | `template-created` | A template has been created | | `template-modified` | A template has been modified | | `template-deleted` | A template has been deleted | | `click-agreed` | A clickwrap agreement has been accepted | | `click-declined` | A clickwrap agreement has been declined | | `sms-opt-in` | A user has opted in to SMS notifications | | `sms-opt-out` | A user has opted out of SMS notifications | | `identity-verification-completed` | Identity verification has been completed | | `identity-verification-pending` | Identity verification is pending | For a complete and up-to-date list of available events, refer to the [DocuSign Webhook Event Triggers](https://developers.docusign.com/platform/webhooks/connect/event-triggers/) documentation. #### Returned Data[​](#returned-data "Direct link to Returned Data") The trigger returns the raw webhook payload sent by DocuSign Connect after validating the HMAC signature. Example Payload ```json { "event": "envelope-completed", "apiVersion": "v2.1", "uri": "/restapi/v2.1/accounts/12345/envelopes/abc-def-ghi", "retryCount": 0, "configurationId": 12345, "generatedDateTime": "2024-01-15T10:30:00.0000000Z", "data": { "accountId": "12345", "envelopeId": "abc-def-ghi", "envelopeSummary": { "status": "completed", "emailSubject": "Please sign this document", "recipients": { "signers": [ { "name": "Jane Doe", "email": "jane@example.com", "status": "completed" } ] } } } } ``` *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Select Folder[​](#folders "Direct link to Select Folder") Select a Folder. | **key: folders** | **type: picklist** | Input | Notes | Example | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | 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[​](#templates "Direct link to Select Template") Select a Template. | **key: templates** | **type: picklist** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ## Actions[​](#actions "Direct link to Actions") ### Create Account[​](#createaccount "Direct link to Create Account") Creates a new DocuSign account. | **key: createAccount** | Input | Notes | Example | | -------------------- | --------------------------------------------------------------------------------- | -------------------------- | | 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[​](#createaccountsignature "Direct link to Create Account Signature") Adds or updates one or more account stamps. | **key: createAccountSignature** | Input | Notes | Example | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountsignatures/createaccountsignatures/ | See Example | *** ### Create Bulk Send List[​](#createbulksendlist "Direct link to 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** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/ | See Example | *** ### Create Contact[​](#createcontact "Direct link to Create Contact") This method adds multiple contacts into a contacts list. | **key: createContact** | Input | Notes | Example | | ---------- | ----------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/create/ | See Example | Example Payload for Create Contact[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/createContact.json "Download example payload") Loading… *** ### Create Envelope[​](#createenvelope "Direct link to Create Envelope") Creates and sends an envelope or creates a draft envelope. | **key: createEnvelope** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | 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/ | See Example | | 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 | Example Payload for Create Envelope[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/createEnvelope.json "Download example payload") Loading… *** ### Create Template[​](#createtemplate "Direct link to Create Template") Creates one or more template definitions, using a multipart request for each template. | **key: createTemplate** | Input | Notes | Example | | ---------- | ---------------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/ | See Example | Example Payload for Create Template[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/createTemplate.json "Download example payload") Loading… *** ### Create Webhook[​](#createwebhook "Direct link to Create Webhook") Create a new webhook (Account Level). | **key: createWebhook** | Input | Notes | Example | | ------------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------------ | | 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 | Example Payload for Create Webhook[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/createWebhook.json "Download example payload") Loading… *** ### Delete Account[​](#deleteaccount "Direct link to Delete Account") Closes the specified account. | **key: deleteAccount** | Input | Notes | Example | | ---------- | ----------------------------------------------------- | -------- | | Account ID | The external account number (int) or account ID GUID. | 23233123 | | Connection | | | *** ### Delete Account Signature[​](#deleteaccountsignature "Direct link to Delete Account Signature") Deletes a stamp specified by signatureId. | **key: deleteAccountSignature** | Input | Notes | Example | | ------------ | ----------------------------------------------------- | ------------------------------------ | | 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[​](#deleteallinstancedwebhooks "Direct link to Delete All Instanced Webhooks") Delete all webhooks that point to a flow in this instance. | **key: deleteAllInstancedWebhooks** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Delete Bulk Send List[​](#deletebulksendlist "Direct link to Delete Bulk Send List") This method deletes a bulk send list. | **key: deleteBulkSendList** | Input | Notes | Example | | ----------------- | --------------------------------------------------------------------------------------------- | ------------------------------------ | | 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[​](#deletecontact "Direct link to Delete Contact") This method deletes a contact associated with an account. | **key: deleteContact** | Input | Notes | Example | | ---------- | --------------------------------------------------------- | ------- | | Connection | | | | Contact ID | The ID of a contact person in the account's address book. | | *** ### Delete Envelope Document[​](#deleteenvelopedocument "Direct link to Delete Envelope Document") Deletes one or more documents from an existing envelope that has not yet been completed. | **key: deleteEnvelopeDocument** | Input | Notes | Example | | ------------ | --------------------------------- | ------------------------------------ | | Connection | | | | Document IDs | A list of document IDs to delete. | \["1", "2", "3"] | | Envelope ID | The envelope's GUID. | d6f6a764-1021-43df-b8db-06c5477dd28a | Example Payload for Delete Envelope Document[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/deleteEnvelopeDocument.json "Download example payload") Loading… *** ### Delete Template Document[​](#deletetemplatedocument "Direct link to Delete Template Document") This method deletes one or more documents from an existing template. | **key: deleteTemplateDocument** | Input | Notes | Example | | ------------ | --------------------------------- | ------------------------------------ | | 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[​](#deleteuser "Direct link to Delete User") Closes one or more users in the account, preventing them from accessing account features. | **key: deleteUser** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | | 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[​](#deletewebhook "Direct link to Delete Webhook") Delete a single webhook. | **key: deleteWebhook** | Input | Notes | Example | | ---------- | --------------------------------------------------------------- | -------- | | Connect ID | The ID of the custom Connect (Webhook) configuration to delete. | 10486941 | | Connection | | | Example Payload for Delete Webhook[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/deleteWebhook.json "Download example payload") Loading… *** ### Get Account[​](#getaccount "Direct link to Get Account") Retrieves the account information for the specified account. | **key: getAccount** | Input | Notes | Example | | ---------- | ----------------------------------------------------- | -------- | | Account ID | The external account number (int) or account ID GUID. | 23233123 | | Connection | | | Example Payload for Get Account[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getAccount.json "Download example payload") Loading… *** ### Get Account Signature[​](#getaccountsignature "Direct link to Get Account Signature") Returns information about the specified stamp. | **key: getAccountSignature** | Input | Notes | Example | | ------------ | --------------------------------------- | ------------------------------------ | | Connection | | | | Signature ID | The unique identifier of the signature. | f1d2e9f6-7b8a-4c3d-9e2f-1a0b3c4d5e6f | *** ### Get Account Signature Image[​](#getaccountsignatureimage "Direct link to Get Account Signature Image") Returns the image for an account stamp. | **key: getAccountSignatureImage** | Input | Notes | Example | | ------------ | --------------------------------------- | ------------------------------------ | | 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[​](#getbulksendbatches "Direct link to Get Bulk Send Batches") Returns a summary of bulk send batches. | **key: getBulkSendBatches** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Get Bulk Send List[​](#getbulksendlist "Direct link to 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** | Input | Notes | Example | | ----------------- | --------------------------------------------------------------------------------------------- | ------------------------------------ | | 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[​](#getbulksendlists "Direct link to 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** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | *** ### Get Bulk Send Status[​](#getbulksendbatchstatus "Direct link to Get Bulk Send Status") Gets the general status of a specific bulk send batch. | **key: getBulkSendBatchStatus** | Input | Notes | Example | | ------------------ | ------------- | ------------------------------------ | | Bulk Send Batch ID | The batch ID. | d6f6a764-1021-43df-b8db-06c5477dd28a | | Connection | | | *** ### Get Contact[​](#getcontact "Direct link to Get Contact") This method returns one or more contacts associated with a DocuSign account. | **key: getContact** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------------------------------------ | ------- | | 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. | | Example Payload for Get Contact[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getContact.json "Download example payload") Loading… *** ### Get Envelope[​](#getenvelope "Direct link to Get Envelope") Retrieves the overall status for the specified envelope. | **key: getEnvelope** | Input | Notes | Example | | --------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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 | Example Payload for Get Envelope[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getEnvelope.json "Download example payload") Loading… *** ### Get Envelope Document[​](#getenvelopedocument "Direct link to Get Envelope Document") Retrieves a single document or all documents from an envelope. | **key: getEnvelopeDocument** | Input | Notes | Example | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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[​](#getrecipientsignature "Direct link to Get Recipient Signature") Retrieves signature information for a signer or sign-in-person recipient. | **key: getRecipientSignature** | Input | Notes | Example | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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[​](#getrecipientsignatureimage "Direct link to Get Recipient Signature Image") Retrieves the specified user signature image. | **key: getRecipientSignatureImage** | Input | Notes | Example | | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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[​](#gettemplate "Direct link to Get Template") Retrieves the definition of the specified template. | **key: getTemplate** | Input | Notes | Example | | ----------- | ----------------------- | ------------------------------------ | | Connection | | | | Template ID | The ID of the template. | d6f6a764-1021-43df-b8db-06c5477dd28a | Example Payload for Get Template[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getTemplate.json "Download example payload") Loading… *** ### Get Template Document[​](#gettemplatedocument "Direct link to Get Template Document") This method retrieves one or more PDF documents from the template that you specify. | **key: getTemplateDocument** | Input | Notes | Example | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | | 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[​](#getuser "Direct link to Get User") Retrieves the user information for the specified user. | **key: getUser** | Input | Notes | Example | | ---------- | ----------------------------- | ------------------------------------ | | Connection | | | | User ID | The ID of the user to access. | a1b5f946-2351-4380-b24e-297e8c708a67 | Example Payload for Get User[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getUser.json "Download example payload") Loading… *** ### Get Webhook[​](#getwebhook "Direct link to Get Webhook") Retrieve a single webhook. | **key: getWebhook** | Input | Notes | Example | | ---------- | -------------------------------------------------------------------- | -------- | | Connect ID | The ID of the custom Connect (Webhook) configuration being accessed. | 10486941 | | Connection | | | Example Payload for Get Webhook[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/getWebhook.json "Download example payload") Loading… *** ### List Account Settings[​](#listaccountsettings "Direct link to List Account Settings") Retrieves the account settings information for the specified account. | **key: listAccountSettings** | Input | Notes | Example | | ---------- | ----------------------------------------------------- | -------- | | Account ID | The external account number (int) or account ID GUID. | 23233123 | | Connection | | | Example Payload for List Account Settings[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/listAccountSettings.json "Download example payload") Loading… *** ### List Envelope Documents[​](#listenvelopedocuments "Direct link to List Envelope Documents") Retrieves a list of documents associated with the specified envelope. | **key: listEnvelopeDocuments** | Input | Notes | Example | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | | 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[​](#listfolderitems "Direct link to List Folder Items") Gets information about items in the specified folder. | **key: listFolderItems** | Input | Notes | Example | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Connection | | | | Fetch All | When enabled, automatically fetches all pages of results using startPosition/count pagination. Start Position and Count inputs are ignored when this is enabled. | false | | 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[​](#listfolders "Direct link to List Folders") Returns a list of the account's folders. | **key: listFolders** | Input | Notes | Example | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | Connection | | | | Count | The maximum number of results to return. | 10 | | Fetch All | When enabled, automatically fetches all pages of results using startPosition/count pagination. Start Position and Count inputs are ignored when this is enabled. | false | | 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[​](#listtemplatedocuments "Direct link to List Template Documents") Retrieves a list of documents associated with the specified template. | **key: listTemplateDocuments** | Input | Notes | Example | | ----------- | ----------------------- | ------------------------------------ | | Connection | | | | Template ID | The ID of the template. | d6f6a764-1021-43df-b8db-06c5477dd28a | Example Payload for List Template Documents[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/listTemplateDocuments.json "Download example payload") Loading… *** ### List Templates[​](#listtemplates "Direct link to List Templates") Retrieves the list of templates for the specified account. | **key: listTemplates** | Input | Notes | Example | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | Connection | | | | Fetch All | When enabled, automatically fetches all pages of results using startPosition/count pagination. Start Position and Count inputs are ignored when this is enabled. | false | Example Payload for List Templates[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/listTemplates.json "Download example payload") Loading… *** ### List Webhooks[​](#listwebhooks "Direct link to List Webhooks") Retrieve all webhooks. | **key: listWebhooks** | Input | Notes | Example | | ---------- | ----- | ------- | | Connection | | | Example Payload for List Webhooks[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/listWebhooks.json "Download example payload") Loading… *** ### Raw Request[​](#rawrequest "Direct link to Raw Request") Send raw HTTP request to DocuSign. | **key: rawRequest** | Input | Notes | Example | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | 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[​](#updateaccountsignature "Direct link to Update Account Signature") Updates an account stamp specified by the signatureId query parameter. | **key: updateAccountSignature** | Input | Notes | Example | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | | 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. | See Example | | 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. | See Example | | 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[​](#updateaccountsignatureimage "Direct link to Update Account Signature Image") Sets a signature image, initials, or stamp. | **key: updateAccountSignatureImage** | Input | Notes | Example | | ------------ | ---------------------------- | ------------------------------------ | | 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[​](#updatebulksendlist "Direct link to Update Bulk Send List") This method replaces the definition of an existing bulk send list. | **key: updateBulkSendList** | Input | Notes | Example | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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/ | See Example | *** ### Update Contact[​](#updatecontact "Direct link to Update Contact") This method updates one or more contacts associated with an account. | **key: updateContact** | Input | Notes | Example | | ---------- | ----------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/users/contacts/update/ | See Example | *** ### Update Envelope[​](#updateenvelope "Direct link to Update Envelope") This method enables you to make changes to an envelope. | **key: updateEnvelope** | Input | Notes | Example | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | 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/ | See Example | | Resend Envelope | When true, resends the specified envelope. | false | Example Payload for Update Envelope[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/updateEnvelope.json "Download example payload") Loading… *** ### Update Envelope Document[​](#updateenvelopedocument "Direct link to Update Envelope Document") Adds or replaces a document in an existing draft or in-process envelope. | **key: updateEnvelopeDocument** | Input | Notes | Example | | ------------- | -------------------------------------------------------------- | ------------------------------------ | | 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[​](#updatetemplate "Direct link to Update Template") Updates an existing template. | **key: updateTemplate** | Input | Notes | Example | | ----------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/update/ | See Example | | Template ID | The ID of the template. | d6f6a764-1021-43df-b8db-06c5477dd28a | Example Payload for Update Template[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/updateTemplate.json "Download example payload") Loading… *** ### Update Template Document[​](#updatetemplatedocument "Direct link to Update Template Document") This methods updates an existing template document. | **key: updateTemplateDocument** | Input | Notes | Example | | ----------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | | 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/ | See Example | | Template ID | The ID of the template. | d6f6a764-1021-43df-b8db-06c5477dd28a | *** ### Update User[​](#updateuser "Direct link to 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** | Input | Notes | Example | | ---------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/users/users/update/ | See Example | | User ID | The ID of the user to access. | a1b5f946-2351-4380-b24e-297e8c708a67 | *** ### Update Webhook[​](#updatewebhook "Direct link to Update Webhook") Update an existing webhook. | **key: updateWebhook** | Input | Notes | Example | | ---------- | -------------------------------------------------------------------------------------------------------------------------- | ----------- | | Connection | | | | JSON Input | For extra fields, see https\://developers.docusign.com/docs/esign-rest-api/reference/connect/connectconfigurations/update/ | See Example | Example Payload for Update Webhook[⤓](https://prismatic.io/docs/example-payloads/docusign/actions/updateWebhook.json "Download example payload") Loading… *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-06-11[​](#2026-06-11 "Direct link to 2026-06-11") Added **Fetch All** toggle to list actions (List Templates, List Folders, List Folder Items) that automatically paginates through all results using `startPosition`/`count` pagination; when disabled, existing single-page behavior is preserved ### 2026-04-30[​](#2026-04-30 "Direct link to 2026-04-30") Updated spectral version ### 2026-04-07[​](#2026-04-07 "Direct link to 2026-04-07") Added trigger documentation ### 2026-03-31[​](#2026-03-31 "Direct link to 2026-03-31") Various modernizations and documentation updates ### 2025-10-22[​](#2025-10-22 "Direct link to 2025-10-22") Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup