DocuSign eSignature Data Source

The DocuSign eSignature connector enables you to ingest envelope data, recipient information, billing records, templates, and workspace files directly from your DocuSign account into Nexla data flows. Follow the instructions below to create a new data flow that ingests data from a DocuSign eSignature source in Nexla.

DocuSign eSignature

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

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

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

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

Configure Using a Template

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

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

Get User Info

Retrieves profile information for the user associated with the current OAuth token, including name, email, and linked account details. Use this endpoint to verify the authenticated user's identity and obtain their associated account IDs before making account-level API calls.

• This endpoint requires no additional parameters. Selecting the template is sufficient — Nexla will call the DocuSign /oauth/userinfo endpoint automatically using the authenticated credential.
• The response includes the user's name, email address, and a list of DocuSign accounts the user has access to, along with each account's ID and base URI.

The account IDs returned by this endpoint are needed for most other DocuSign API calls. Use this endpoint first if you need to discover which DocuSign accounts are accessible with your current credentials.

Get Account Information

Retrieves detailed information for a specified DocuSign account, optionally including account settings. Use this endpoint to inspect account configuration, features enabled, and metadata about your DocuSign organization.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account to retrieve. This can be obtained from the Get User Info endpoint or from your DocuSign account settings under Settings > Account Profile > API Account ID.
  • Include Account Settings: Set to true to include the full list of account-level settings in the response, or false to retrieve only basic account information.

Get Billing Invoice

Retrieves a specific billing invoice for a DocuSign account by invoice ID. Use this endpoint to pull individual invoice details for financial reconciliation, audit trails, or accounts payable workflows.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account associated with the invoice.
  • Invoice ID: The unique identifier of the invoice to retrieve. Invoice IDs can be found in the DocuSign billing console under Settings > Billing > Invoices.

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

List Past Due Invoices

Retrieves a list of all past due invoices for a specified DocuSign account. Use this endpoint to identify outstanding billing obligations and build automated payment reminders or finance dashboards.

• Enter the Account ID — the GUID of the DocuSign account for which past due invoices should be retrieved.
• The response returns an array of invoice objects, each containing invoice ID, amount due, due date, and status. Nexla will create one record per invoice in the resulting Nexset.

Get Billing Payment

Retrieves billing payment information for a specific payment record. Use this endpoint to verify payment status and pull payment details for financial reconciliation.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account associated with the payment.
  • Payment ID: The unique identifier of the payment to retrieve.

Get Account Billing Plan

Retrieves billing plan information for a specified DocuSign account, optionally including credit card details and successor plan information. Use this endpoint to monitor subscription status, plan limits, or upcoming plan changes.

• Enter the Account ID — the GUID of the DocuSign account whose billing plan you want to retrieve.
• Set Include Credit Card Information to true to include payment method details in the response.
• Set Include Metadata to true to include additional plan metadata.
• Set Include Successor Plans to true to include information about any upcoming plan changes or renewals.

Get Downgrade Plan Information

Retrieves information about any pending billing plan downgrade for a specified account. Use this endpoint to monitor queued plan changes before they take effect.

• Enter the Account ID — the GUID of the DocuSign account for which downgrade plan information should be retrieved.
• The response includes details about the pending downgrade, including the target plan and effective date, if a downgrade has been queued.

Get billing plan details

Retrieves detailed information about a specific DocuSign billing plan by its plan ID. Use this endpoint to compare available billing plans, review plan features, or support upgrade/downgrade decision workflows.

• Enter the Billing Plan ID — the unique identifier of the billing plan to retrieve. Billing plan IDs can be found in the DocuSign billing plan documentation or by reviewing the plan details in your DocuSign account under Settings > Billing > Change Plan.

List bulk send batch statuses

Returns a paginated list of bulk send batch statuses for a DocuSign account. Use this endpoint to monitor the progress and results of bulk envelope sending operations, which allow you to send the same document to a large number of recipients simultaneously.

• Enter the Account ID — the GUID of the DocuSign account for which bulk send batch statuses should be listed.
• Optionally, enter comma-separated Batch IDs to filter results to specific bulk send batches.
• Optionally, enter a Status value to filter batches by their current status (e.g., queued, processing, completed, failed).
• This endpoint uses pagination. Nexla will automatically retrieve additional pages to ensure all matching batch records are included in the resulting Nexset.

Bulk send batches are created when you send envelopes to multiple recipients at once using the DocuSign Bulk Send feature. Each batch can contain up to 1,000 recipients.

List envelope status changes

Gets status changes for one or more envelopes with optional filtering by date range, status, folder, user, and other criteria. This is one of the most commonly used DocuSign endpoints and is ideal for building envelope tracking dashboards, audit reports, or event-driven workflows.

• Enter the Account ID — the GUID of the DocuSign account from which envelopes should be retrieved.

• Use the available filter parameters to narrow results as needed:

  • From Date: Retrieve only envelopes with status changes on or after this date (format: YYYY-MM-DD). This parameter is required unless envelope_ids or transaction_ids is specified.
  • To Date: Retrieve only envelopes with status changes on or before this date (format: YYYY-MM-DD).
  • Status: Filter by envelope status, such as sent, delivered, completed, declined, or voided.
  • Envelope IDs: Comma-separated list of specific envelope GUIDs to retrieve.
  • From To Status: Filter envelopes by a specific status transition (e.g., changed).
  • User ID: Filter envelopes by the GUID of the sender.
  • Folder IDs: Comma-separated folder IDs to limit results to envelopes in specific folders.
  • Include: Comma-separated list of additional data to include in the response, such as recipients, documents, tabs, or custom_fields.
• This endpoint supports pagination. Nexla will automatically page through results to retrieve all matching envelopes.

The from_date parameter is required unless you specify envelope_ids or transaction_ids. For ongoing incremental ingestion, use Nexla date/time macros (such as {"{now-1}"} for the previous day) in the from_date parameter when configuring manually, or schedule this source to run periodically to capture new status changes.

Get envelope status

Retrieves the status and full details of a specific envelope by its envelope ID. Use this endpoint when you need to inspect a single envelope's current state, recipients, documents, and signing history.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the envelope.
  • Envelope ID: The unique GUID of the envelope to retrieve. Envelope IDs can be found in the DocuSign web application or by first using the List Envelope Status Changes endpoint.
• Optionally, set Advanced Update to true to enable advanced envelope update options in the response.
• Optionally, enter a comma-separated Include list to add extra information to the response, such as recipients, documents, custom_fields, tabs, or extensions.

Get envelope recipients

Retrieves the status and information for all recipients in a specific envelope. Use this endpoint to track who has signed, who is pending, and any recipient-level activity on an envelope.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the envelope.
  • Envelope ID: The GUID of the envelope whose recipients you want to retrieve.
• Set Include Extended to true to include extended recipient details in the response.
• Set Include Tabs to true to include the recipient's tab (field) data in the response.
• Set Include Metadata to true to include recipient metadata such as custom data fields.
• The response returns an array of recipient objects organized by recipient type (signers, carbon copies, certified delivery, etc.). Nexla will create one record per recipient in the resulting Nexset.

Get recipient tabs

Retrieves tab (form field) information for a specific signer or sign-in-person recipient within an envelope. Tabs represent the signature fields, text fields, checkboxes, and other interactive elements placed on documents for recipients to complete. Use this endpoint to extract form data filled in by signers.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the envelope.
  • Envelope ID: The GUID of the envelope containing the recipient.
  • Recipient ID: The ID of the specific recipient whose tabs you want to retrieve. Recipient IDs can be obtained from the Get Envelope Recipients endpoint.
• Set Include Anchor Tab Locations to true to include the position data for anchor-placed tabs.
• Set Include Metadata to true to include additional tab metadata in the response.

Tab data contains the values entered or selected by signers in form fields. This endpoint is particularly useful for extracting structured data from completed agreements for downstream processing or storage.

Get Envelope Status (Examples)

Retrieves the status and details of a specific envelope using the API version-parameterized URL format. This template is functionally equivalent to the Get Envelope Status endpoint and is provided as a reference implementation example with explicit API version configuration.

• Enter the required parameters for this endpoint:

  • API Version: The DocuSign eSignature REST API version to use (e.g., v2.1).
  • Account ID: The GUID of the DocuSign account that owns the envelope.
  • Envelope ID: The GUID of the envelope whose status you want to retrieve.

Get Template

Retrieves a specific envelope template by its template ID for the specified DocuSign account. Templates are reusable envelope definitions that define the documents, recipients, and form fields for a standard signing workflow. Use this endpoint to inspect template configuration or audit template contents.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the template.
  • Template ID: The GUID of the template to retrieve. Template IDs can be found in the DocuSign web application under Templates, or by listing templates via the DocuSign API.
• Optionally, enter a comma-separated Include list to add extra information to the response, such as recipients, tabs, documents, or custom_fields.

Get Workspace

Retrieves information about a specific DocuSign workspace. Workspaces are collaborative environments within DocuSign where teams can share, manage, and work with documents. Use this endpoint to retrieve workspace metadata and configuration.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the workspace.
  • Workspace ID: The unique ID of the workspace to retrieve.

Get Workspace File

Retrieves a specific file from a DocuSign workspace folder. Use this endpoint to access documents stored in workspace folders for download or further processing.

• Enter the required parameters for this endpoint:

  • Account ID: The GUID of the DocuSign account that owns the workspace.
  • Workspace ID: The unique ID of the workspace containing the file.
  • Folder ID: The ID of the folder within the workspace where the file is located.
  • File ID: The unique ID of the file to retrieve.
• Set Is Download to true to retrieve the file content as a download rather than metadata only.
• Set PDF Version to true to retrieve the file as a PDF, even if it was originally uploaded in another format.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

DocuSign eSignature data sources can be manually configured to ingest data from any valid DocuSign eSignature API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex DocuSign eSignature sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

1. To manually configure this source, 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. The most common methods are:

   • GET: For retrieving data from the API (most DocuSign read endpoints use GET)
   • POST: For sending data to the API or triggering actions

API Endpoint URL

3. Enter the URL of the DocuSign eSignature API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

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), and {accountId} is your DocuSign account GUID. Your account's base URI is displayed in DocuSign under Settings > Apps and Keys > Account Base URI.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful with the DocuSign List Envelopes endpoint, which accepts from_date and to_date query parameters. For example, appending ?from_date={"{now-1}"} to the envelopes URL retrieves only envelopes with status changes since the previous run period.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to create DocuSign API endpoints that reference specific account IDs, envelope IDs, or other values drawn from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when retrieving a list of envelopes, the DocuSign API returns a response object containing both an envelopes array and pagination metadata. By entering the path $.envelopes[*], you can configure Nexla to treat each envelope object in the array as a separate record.

Path to Data is essential when DocuSign API responses have nested structures. Most DocuSign list endpoints return arrays nested under a named key (e.g., envelopes, recipients, invoices, bulkBatches). Without specifying the correct path, Nexla may not properly parse the response into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.envelopes[*] to access the envelopes array, or $.invoices[*] for the invoices array).
  Path to Data Example:

  For the List Envelope Status Changes endpoint, the response returns envelopes under the envelopes key. Enter $.envelopes[*] as the path to configure Nexla to treat each envelope as a separate record.

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

Metadata paths are particularly useful for preserving DocuSign API response context such as pagination tokens, result totals, or query timestamps that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or specific DocuSign endpoint requirements.

  You do not need to include any headers already present in the credentials. The Authorization: Bearer {token} header is automatically managed by Nexla based on your DocuSign eSignature credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new DocuSign eSignature data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.