Skip to main content

DocuSign eSignature Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a DocuSign eSignature location.
docusign_api.png

DocuSign eSignature

Create a DocuSign eSignature Destination​

  1. Click the + icon on the Nexset that will be sent to the DocuSign eSignature destination, and select the Send to Destination option from the menu.

  2. Select the DocuSign eSignature connector from the list of available destination connectors. Then, select the credential that will be used to connect to the DocuSign eSignature organization, and click Next; or, create a new DocuSign eSignature credential for use in this flow.

  3. In Nexla, DocuSign eSignature destinations can be created using pre-built endpoint templates, which expedite destination setup for common DocuSign eSignature endpoints. Each template is designed specifically for the corresponding DocuSign eSignature endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    DocuSign eSignature destinations can also be configured manually, allowing you to send data to DocuSign eSignature endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common DocuSign eSignature endpoints. Each template is designed specifically for the corresponding DocuSign eSignature endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create Billing Payment

    Posts a payment to a past due invoice for a DocuSign account. Use this endpoint to programmatically submit payments for outstanding invoices, enabling automated accounts payable workflows.

    • Enter the Account ID — the GUID of the DocuSign account for which the billing payment will be posted. This value is appended to the API URL path and identifies the account to which the payment is applied.

    • Prepare your Nexset data to include the payment fields required by the DocuSign Billing Payments API. The request body should include:

    • Data is sent as JSON in the request body. Nexla will automatically serialize each Nexset record as a JSON object for each API call.

    Access to billing endpoints typically requires Admin-level permissions in DocuSign. Ensure your credential's user account has the appropriate role before configuring this destination.

    Queue Downgrade Billing Plan

    Queues a billing plan downgrade request for a DocuSign account. Use this endpoint to programmatically schedule a plan change to a lower-tier DocuSign subscription that will take effect at the end of the current billing period.

    • Enter the Account ID — the GUID of the DocuSign account for which the billing plan downgrade will be queued.

    • Prepare your Nexset data to include the downgrade plan fields required by the DocuSign API. The request body should include:

      • planId: The ID of the billing plan to downgrade to. Available plan IDs can be retrieved using the Get Billing Plan Details source endpoint.
      • Refer to the DocuSign Downgrade Plan API reference for the full list of supported request body fields.

    Plan downgrades are queued and take effect at the end of the current billing period — they are not immediate. Use the Get Downgrade Plan Information source endpoint to verify the queued downgrade before it takes effect.

    Purchase Additional Envelopes

    Reserves and purchases additional envelopes for a DocuSign account. Use this endpoint to programmatically increase the envelope allotment for an account when the current plan's envelope quota is running low.

    • Enter the Account ID — the GUID of the DocuSign account for which additional envelopes will be purchased.

    • Prepare your Nexset data to include the envelope purchase fields required by the DocuSign API. The request body should include:

    Create an envelope

    Creates a new DocuSign envelope and sends it to recipients for signature. An envelope is the container for documents to be signed and the recipients who will sign them. Use this endpoint to programmatically initiate document signing workflows from your Nexla data flows.

    • Enter the Account ID — the GUID of the DocuSign account in which the envelope will be created.

    • Prepare your Nexset data to include the envelope creation fields required by the DocuSign Envelopes API. Key request body fields include:

      • status: Set to sent to immediately send the envelope for signature, or created to save it as a draft for later sending.
      • documents: An array of document objects containing the files to be signed (as base64-encoded content or template references).
      • recipients: An object defining the signers, carbon copy recipients, and other recipient types, including their names, email addresses, and routing order.
      • emailSubject: The subject line of the email notification sent to recipients.
      • Refer to the DocuSign Create Envelope API reference for the full list of supported request body fields.
    • Optional query parameters can be specified in the endpoint URL to control behavior, such as cdse_mode, merge_roles_on_draft, and tab_label_exact_matches.

    DocuSign envelopes consume envelope quota from your DocuSign account plan. Ensure your account has sufficient envelope quota before creating envelopes in bulk.

    Update envelope status

    Sends, voids, moves, purges, or modifies an existing DocuSign envelope. Use this endpoint to programmatically change the status or properties of an envelope that has already been created — for example, voiding an envelope that was sent in error or resending a reminder to recipients.

    • Enter the Account ID — the GUID of the DocuSign account that owns the envelope.
    • Enter the Envelope ID — the GUID of the envelope to update. Envelope IDs can be retrieved using the List Envelope Status Changes or Get Envelope Status source endpoints.

    • Prepare your Nexset data to include the update fields required by the DocuSign Envelopes API. Common update operations include:

      • Set status to voided and include a voidedReason to void the envelope.
      • Set the optional resend_envelope query parameter to true to resend notification emails to pending recipients.
      • Refer to the DocuSign Update Envelope API reference for the full list of supported fields and operations.

    Voiding an envelope is permanent and cannot be undone. Recipients will receive a notification that the envelope has been voided.

    Update recipient tabs

    Updates the tabs (form fields) for a specific recipient in a DocuSign envelope. Tabs are the interactive elements—such as signature fields, text boxes, checkboxes, and date fields—placed on documents for recipients to complete. Use this endpoint to programmatically pre-populate or modify form field values before recipients sign.

    • Enter the Account ID — the GUID of the DocuSign account that owns the envelope.
    • Enter the Envelope ID — the GUID of the envelope containing the recipient whose tabs will be updated.
    • Enter the Recipient ID — the ID of the specific recipient whose tabs you want to update. Recipient IDs can be obtained from the Get Envelope Recipients source endpoint.

    • Prepare your Nexset data to include the tab update fields required by the DocuSign API. Key request body fields include:

      • textTabs: An array of text field tab objects with updated values.
      • checkboxTabs: An array of checkbox tab objects with updated checked/unchecked state.
      • Refer to the DocuSign Update Recipient Tabs API reference for the full list of supported tab types and fields.

    Get recipient view URL

    Returns a URL that opens the DocuSign embedded signing interface for a specific recipient. Use this endpoint to embed the signing experience directly into your application, allowing recipients to sign documents within your own web UI without leaving to DocuSign's hosted interface.

    • Enter the Account ID — the GUID of the DocuSign account that owns the envelope.
    • Enter the Envelope ID — the GUID of the envelope for which the recipient view URL will be generated.

    • Prepare your Nexset data to include the recipient view request fields required by the DocuSign API. Key request body fields include:

      • returnUrl: The URL the signer is redirected to after completing or declining to sign. This should be a page within your application.
      • recipientId: The ID of the recipient for whom the signing URL is being generated.
      • email and userName: The recipient's email address and name, used to authenticate the signing session.
      • Refer to the DocuSign Recipient View API reference for the full list of supported request body fields.
    • The API returns a url field in the response containing the time-limited signing URL. This URL is valid for a short period (typically 5 minutes) and should be presented to the recipient promptly.

    Embedded signing URLs are single-use and expire quickly. Generate the URL only immediately before presenting it to the recipient. For production embedded signing implementations, review the DocuSign embedded signing guide for best practices.

    Create Envelope from Template

    Creates a new DocuSign template or creates an envelope using an existing template. DocuSign templates define reusable document structures with predefined recipients and form fields, making it faster to send standard agreement types. Use this endpoint to programmatically send envelopes based on standardized templates.

    • Enter the Account ID — the GUID of the DocuSign account in which the envelope or template will be created.

    • Prepare your Nexset data to include the template-based envelope fields required by the DocuSign Templates API. Key request body fields include:

      • templateId: The GUID of the DocuSign template to use. Template IDs can be found in the DocuSign web application under Templates.
      • templateRoles: An array of objects mapping your recipients to the template's predefined roles, including each recipient's name, email, and role name.
      • status: Set to sent to immediately send for signature, or created to save as a draft.
      • Refer to the DocuSign Templates API reference for the full list of supported request body fields.

    Using templates is the most efficient way to send standardized agreements at scale. Templates pre-define documents, signing fields, and recipient roles — reducing the amount of data needed in each API request compared to creating envelopes from scratch.

    Create Envelope (Examples)

    Creates an envelope with a document and recipients using the API version-parameterized URL format. This template is functionally equivalent to the Create an Envelope endpoint and is provided as a reference implementation example with explicit API version configuration.

    • Enter the API Version — the DocuSign eSignature REST API version to use in the URL (e.g., v2.1).
    • Enter the Account ID — the GUID of the DocuSign account in which the envelope will be created.
    • Prepare your Nexset data with the same envelope creation fields described in the Create an Envelope template above.

    Create Envelope in Draft Stage

    Creates a DocuSign envelope in draft (created) status with documents and recipients. Draft envelopes are saved but not yet sent to recipients. Use this endpoint when you want to create envelopes for review or modification before sending, or when a human step is required before dispatching agreements.

    • Enter the API Version — the DocuSign eSignature REST API version to use in the URL (e.g., v2.1).
    • Enter the Account ID — the GUID of the DocuSign account in which the draft envelope will be created.

    • Prepare your Nexset data to include the envelope fields required by the DocuSign Envelopes API. Set the status field to created to save the envelope as a draft. Key fields include:

      • documents: An array of document objects to include in the envelope.
      • recipients: An object defining the recipient information and signing order.
      • emailSubject: The subject line of the email notification that will be sent when the envelope is later sent.
      • Refer to the DocuSign Create Envelope API reference for the full list of supported fields.

    Draft envelopes do not consume DocuSign envelope quota until they are sent. To send a draft envelope, use the Update Envelope Status endpoint with status: sent.

    Send Envelope with Template

    Creates and immediately sends an envelope using a DocuSign template. This endpoint is optimized for high-volume template-based sending workflows. Use this endpoint when you want to send standardized agreements to recipients as part of an automated data flow.

    • Enter the API Version — the DocuSign eSignature REST API version to use in the URL (e.g., v2.1).
    • Enter the Account ID — the GUID of the DocuSign account from which the envelope will be sent.

    • Prepare your Nexset data to include the template-based envelope sending fields. Key fields include:

      • templateId: The GUID of the DocuSign template to use.
      • templateRoles: An array of recipient role assignments, each including the recipient's name, email, and role name as defined in the template.
      • status: Set to sent to immediately dispatch the envelope to recipients.
      • Refer to the DocuSign Envelopes API reference for the full list of supported fields.

    Send Envelope Using Composite Templates

    Creates and sends an envelope using composite templates — a DocuSign feature that allows combining multiple templates and inline documents in a single envelope. Composite templates give you the flexibility to apply different templates to different documents within the same envelope, or to overlay inline document content on top of template-based documents.

    • Enter the API Version — the DocuSign eSignature REST API version to use in the URL (e.g., v2.1).
    • Enter the Account ID — the GUID of the DocuSign account from which the envelope will be sent.

    • Prepare your Nexset data to include the composite template envelope fields. Key fields include:

      • compositeTemplates: An array of composite template objects, each defining a combination of server templates, inline templates, and document content to include in the envelope.
      • status: Set to sent to immediately dispatch the envelope.
      • Refer to the DocuSign Envelopes API reference and the composite templates guide for full details on the composite template structure.

    Composite templates are an advanced DocuSign feature suited for complex signing scenarios. Review the DocuSign composite templates documentation before configuring this endpoint to understand the structure and available options.

    Create Workspace

    Creates a new workspace for a DocuSign account. Workspaces are collaborative environments within DocuSign where teams can share, manage, and collaborate on documents. Use this endpoint to programmatically provision new workspaces as part of onboarding or organizational workflows.

    • Enter the Account ID — the GUID of the DocuSign account in which the workspace will be created.

    • Prepare your Nexset data to include the workspace creation fields required by the DocuSign Workspaces API. Key fields include:

Configure Manually​

DocuSign eSignature destinations can be manually configured to send data to any valid DocuSign eSignature API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the DocuSign eSignature API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the DocuSign eSignature API from the Method pulldown menu. Common methods for DocuSign write operations include:

    • POST: For creating new resources (envelopes, workspaces, payments)
    • PUT: For updating or replacing existing resources (envelope status, billing plan changes)

Data Format​

  1. Select the format in which the Nexset data will be sent to the DocuSign eSignature API from the Content Format pulldown menu. DocuSign's REST API accepts JSON for all write operations — select JSON to ensure compatibility.

API Endpoint URL​

  1. Enter the URL of the DocuSign eSignature API endpoint to which you want to send the Nexset data in the URL field. For update operations, include the ID of the object to be updated at the end of the URL.

DocuSign API URLs follow the pattern https://{your-host}/v2.1/accounts/{accountId}/{resource}, where {your-host} is your account's base URI (e.g., na2.docusign.net or demo.docusign.net). Your account's base URI is displayed under Settings > Apps and Keys > Account Base URI in your DocuSign account.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The Authorization: Bearer {token} and Content-Type: application/json headers are automatically managed by Nexla based on your DocuSign eSignature credential and Content Format selection.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this DocuSign eSignature destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Most DocuSign API write endpoints accept a single object per call, not arrays of records. Verify that your target DocuSign endpoint supports batched requests before enabling record batching.

Response Webhook​

Optional

Nexla can automatically send the response received from the DocuSign eSignature API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the envelope ID created by a Create Envelope call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the DocuSign eSignature API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the DocuSign eSignature API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the DocuSign eSignature API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured DocuSign eSignature endpoint, open the destination resource menu and select Activate.

    The Nexset data will not be sent to DocuSign eSignature until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.