Docuseal Data Source

The Docuseal connector enables you to ingest document submission data, template metadata, and submitter records from your DocuSeal account into Nexla. Follow the instructions below to create a new data flow that ingests data from a Docuseal source in Nexla.

Docuseal

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 Docuseal connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Docuseal instance, and click Next; or, create a new Docuseal credential for use in this flow.

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

   Docuseal sources can also be configured manually, allowing you to ingest data from Docuseal 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 Docuseal endpoints. Each template is designed specifically for the corresponding DocuSeal API resource, 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.

List Submissions

Returns a paginated list of all document submissions in your DocuSeal account. Use this endpoint to retrieve an up-to-date inventory of all signature requests, including their statuses, submitters, and associated templates. This is the most common endpoint for building submission monitoring dashboards and audit workflows.

• This endpoint automatically paginates through all available submissions using DocuSeal's cursor-based pagination. Nexla fetches up to 100 submissions per page and continues retrieving additional pages until all records have been ingested.
• No additional configuration is required beyond selecting this endpoint template. The endpoint fetches all submissions accessible to the authenticated account.
• Each submission record includes the submission ID, status (pending, completed, expired, etc.), creation and completion timestamps, associated template information, and the list of submitters with their individual completion statuses.

The List Submissions endpoint supports date-based filtering in the DocuSeal API. For incremental or time-bounded ingestion, consider using the manual configuration option to add date filter query parameters to the endpoint URL. Refer to the DocuSeal API Reference for supported query parameters.

Get Submission

Retrieves the full details of a single document submission by its unique ID, including the submission status, all submitter records, field values provided by each submitter, and the audit log URL. Use this endpoint when you need comprehensive details about a specific submission.

• Enter the unique identifier of the submission you want to retrieve in the Submission ID field. This is a required field.

  • Submission IDs are numeric identifiers assigned by DocuSeal when a submission is created. They can be obtained from the List Submissions endpoint, from DocuSeal's web dashboard, or from submission creation API responses.
• The response includes the full submission object: status, created and completed timestamps, template ID and name, submitter details (name, email, role, completion status, field values), and a URL to the audit log PDF.

Use this endpoint to build detailed submission tracking or compliance workflows where complete submitter field values and the audit trail are required. The audit log URL in the response provides access to a tamper-evident PDF record of the signing process.

Get Submission Documents

Returns the partially-filled or fully completed signed documents associated with a specific submission. Use this endpoint to retrieve metadata and download URLs for the signed PDF documents produced by a submission.

• Enter the unique identifier of the submission whose documents you want to retrieve in the Submission ID field. This is a required field.

  • Submission IDs can be found using the List Submissions endpoint or from the DocuSeal dashboard. Documents are available for both in-progress (partially filled) and completed submissions.
• The response returns an array of document objects under the documents key, with each object including the document name, download URL, and content type.

Completed signed documents are available immediately after all required submitters have signed. For submissions still in progress, partially completed documents reflecting the fields filled so far are returned.

List Templates

Returns a paginated list of all document templates in your DocuSeal account. Templates are reusable document structures that define the fields, roles, and signing order for a document signing workflow. Use this endpoint to audit available templates, sync template metadata to downstream systems, or build template selection interfaces.

• This endpoint automatically paginates through all available templates using cursor-based pagination, fetching up to 100 templates per page until all records have been retrieved.
• No additional configuration is required. The endpoint retrieves all templates accessible to the authenticated API key.
• Each template record includes the template ID, name, folder, creation and update timestamps, the list of defined roles (submitter roles), and the number of submissions created from the template.

Template IDs returned by this endpoint are the values required when creating new submissions via the Create Submission destination endpoint. Use List Templates to look up the correct template ID for a given document type.

Get Template

Retrieves the full details of a single document template by its unique ID, including its defined fields, submitter roles, schema, and metadata. Use this endpoint when you need the complete field structure of a specific template—for example, to understand which fields are available for pre-filling when creating submissions.

• Enter the unique identifier of the template you want to retrieve in the Template ID field. This is a required field.

  • Template IDs are numeric identifiers assigned by DocuSeal. They can be found using the List Templates endpoint or in the DocuSeal web dashboard under the template details.
• The response includes the complete template object: name, folder, creation/update timestamps, defined submitter roles, and the full list of fields with their types, names, positions, and validation settings.

List Submitters

Returns a paginated list of all submitters (signers) associated with submissions in your DocuSeal account. Submitters are the individuals who receive, fill, and sign documents. Use this endpoint to retrieve a complete record of all signing parties across all submissions—useful for compliance reporting, contact management, and audit workflows.

• This endpoint automatically paginates through all available submitter records using cursor-based pagination, fetching up to 100 records per page until all submitters have been retrieved.
• No additional configuration is required. All submitters accessible to the authenticated account are returned.
• Each submitter record includes the submitter ID, name, email address, phone number (if provided), role, completion status, the submission it belongs to, and the values provided for each form field.

The List Submitters endpoint can be filtered by submission ID or email address in the DocuSeal API. For filtered ingestion, use the manual configuration option to append query parameters such as submission_id or q (email search) to the endpoint URL.

Get Submitter

Retrieves the full details of a single submitter record by their unique ID, including their provided field values, submitted documents, and completion status. Use this endpoint when you need comprehensive information about a specific signer within a submission.

• Enter the unique identifier of the submitter you want to retrieve in the Submitter ID field. This is a required field.

  • Submitter IDs are numeric identifiers assigned by DocuSeal when a submission is created. They can be found using the List Submitters endpoint or in the Get Submission response, which includes the IDs of all submitters associated with a submission.
• The response includes the submitter's ID, name, email, role, completion status, the values they entered for each field, and URLs to the documents they signed.

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

Docuseal data sources can be manually configured to ingest data from any valid DocuSeal 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 Docuseal sources, such as sources that use chained API calls to fetch data from multiple endpoints, or sources that require additional query parameters for filtering by date range, status, or other criteria supported by the DocuSeal API.

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 Docuseal API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API (submissions, templates, submitters)
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the DocuSeal API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the base URL for your deployment and the resource path.

   DocuSeal API base URLs:

   • Global Cloud: https://api.docuseal.com
   • EU Cloud: https://api.docuseal.eu
   • Self-Hosted: Your custom instance API URL (e.g., https://yourdocuseal.example.com/api)

   Example endpoint URLs:

   • List all submissions: https://api.docuseal.com/submissions
   • Get a single submission: https://api.docuseal.com/submissions/12345
   • List templates: https://api.docuseal.com/templates
   • List submitters with filter: https://api.docuseal.com/submitters?submission_id=12345

The DocuSeal API supports several query parameters for filtering list endpoints, including limit (page size), after (cursor for pagination), q (search by email for submitters), and date range filters. Refer to the DocuSeal API Reference for the full list of supported parameters for each endpoint.

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 for DocuSeal endpoints that support date filtering. For example, you can use macros to build a URL that always fetches submissions created or updated within the last day, ensuring incremental data ingestion runs remain time-bounded.

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 for DocuSeal sources when you need to retrieve submissions or submitter details for a specific set of IDs sourced from another Nexla dataset—for example, fetching submission details for IDs returned by a previous workflow step.

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 DocuSeal 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.

For example, DocuSeal list endpoints return responses structured as {"data": [...], "pagination": {...}}. By specifying the path to the data array, Nexla will treat each element of that array as an individual record rather than treating the entire response as a single record.

Path to Data is essential for DocuSeal list endpoints. Without specifying the correct path, Nexla may treat the entire API response (including pagination metadata) as a single record rather than extracting individual submission, template, or submitter 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., $.data.items[*] to access an array of items within a data object).

  • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

  Path to Data Example:

  DocuSeal list endpoints (submissions, templates, submitters) return a top-level data array containing the actual records. Enter $.data[*] as the path to extract each item in the array as a separate record. For single-object endpoints (e.g., Get Submission, Get Template), use $ to treat the entire response as one 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.

For example, DocuSeal list endpoint responses include a pagination object alongside the data array. If pagination metadata (such as the cursor for the next page) needs to be preserved alongside each record, you can specify the path to that metadata here.

Metadata paths are particularly useful for preserving API response context like pagination tokens, request timestamps, or summary statistics 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, and for responses in XML format, enter the XPath.

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 are often required for API versioning, content type specifications, or custom authentication requirements.

  You do not need to include the X-Auth-Token authentication header here—this is handled automatically by Nexla based on your Docuseal credential configuration. Common headers like Authorization and Content-Type are managed by the credential.

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 Docuseal 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.