Skip to main content

Docuseal 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 Docuseal location.
docuseal_api.png

Docuseal

Create a Docuseal Destination​

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

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

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

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

    Creates a new signature request (submission) for an existing DocuSeal document template and sends it to one or more specified submitters (signers) via email or SMS. Use this endpoint to automate the initiation of document signing workflows from your data pipelines—for example, triggering an NDA or contract signature request when a new customer record is created in your CRM.

    • The request body must include the template_id of the DocuSeal template to use and a submitters array specifying each signing party. Each submitter object requires at minimum an email address and a role value matching one of the roles defined in the template.

    • The Nexset data sent to this endpoint should be structured as a JSON payload with the required fields. A minimal example payload looks like this:

      • template_id: The numeric ID of the DocuSeal template to use (obtainable from the List Templates source endpoint or the DocuSeal dashboard).
      • submitters: An array of submitter objects, each with email, role, and optionally name, phone, and pre-filled fields values.
    • Submitters will receive an email invitation with a link to the signing form. Upon completion, all parties receive a copy of the signed document.
    • Optional fields in the request body include message (custom email subject and body), send_email (set to false to suppress invitation emails), expire_at (submission expiration date), and order (sequential or parallel signing order).

    Template IDs can be retrieved using the Docuseal List Templates or Get Template source endpoints. Submitter roles must exactly match the role names defined in the selected template. Refer to the DocuSeal API Reference for the complete list of supported request body fields.

    Create Submission from PDF

    Creates a one-off submission request directly from a PDF file, without requiring a pre-existing DocuSeal template. Use this endpoint when you need to send a unique document for signing that does not have a corresponding reusable template in DocuSeal—for example, generating a custom agreement from a PDF stored in your data pipeline.

    • Fields within the PDF can be defined using text tags embedded in the document content. Text tags follow the format {{Field Name;role=Signer1;type=date}}, where each tag specifies the field name, the submitter role it belongs to, and the field type.
    • Alternatively, field positions can be specified explicitly via the fields parameter using exact pixel coordinates on the document pages, which is useful for PDFs where text tags cannot be embedded.
    • The request body must include the PDF file (as a Base64-encoded string or a URL) and the submitters array with at least one submitter's email and role.

    PDF-based submissions are one-off requests and do not create reusable templates in DocuSeal. For recurring document types, consider using the Create Template from PDF endpoint to create a reusable template first, then use the Create Submission endpoint. Refer to the DocuSeal API Reference for supported field types and coordinate-based field configuration.

    Create Submission from DOCX

    Creates a one-off submission request from a DOCX file with dynamic content variables. Use this endpoint to generate personalized documents from a Word template with variable data substituted at submission creation time—for example, inserting a recipient's name, address, or contract terms from your data pipeline into a standard agreement document.

    • Dynamic content variables are defined in the DOCX file using double-bracket tags (e.g., [[variable_name]]). The values for these variables are provided in the request body's submitters[].values object, allowing each submission to be personalized with data-driven content.
    • The request body must include the DOCX file (as a Base64-encoded string or a URL) and the submitters array specifying each signing party's email, role, and any variable values to substitute into the document.

    Variable tags in the DOCX file use double square brackets (e.g., [[customer_name]]), which is distinct from the text field tags used in PDF submissions. Ensure variable names in the request body exactly match the tag names in the document. Refer to the DocuSeal API Reference for additional details on DOCX variable substitution.

    Create Submission from HTML

    Creates a one-off submission request from HTML content, which DocuSeal renders into a fillable and signable document. Use this endpoint to dynamically generate documents from HTML content built or templated in your data pipeline—for example, creating a formatted contract or disclosure form from structured data.

    • Fillable and signable fields are embedded in the HTML using special DocuSeal field tags. The HTML is rendered server-side into a PDF document that recipients can sign in the DocuSeal signing interface.
    • The request body must include the html content string and the submitters array specifying each signing party's email and role.

    HTML-based submissions allow flexible, programmatically generated document content. Refer to the DocuSeal API Reference for the supported HTML field tag syntax and any CSS or formatting limitations.

    Create Submissions from Emails

    A simplified API endpoint designed to create submissions for a document template and send them to a list of email addresses in a single request. This endpoint is optimized for automation use cases where each recipient signs an independent copy of the same template—for example, sending a policy acknowledgment or annual disclosure to a list of employees or customers.

    • The request body must include the template_id of the DocuSeal template to use and an emails array containing the email addresses of all recipients. Each recipient will receive their own independent submission.
    • Unlike the standard Create Submission endpoint, this simplified endpoint does not require specifying submitter roles or additional submitter metadata—making it ideal for single-signer templates distributed to many recipients.

    This endpoint is designed for single-role templates where the same document is sent to multiple recipients independently. For multi-party signing workflows or submissions requiring role assignments or pre-filled fields, use the standard Create Submission endpoint. Refer to the DocuSeal API Reference for complete request body specifications.

    Archive Submission

    Archives (soft-deletes) a submission by its unique ID. Archived submissions are removed from the active submissions list in DocuSeal but are not permanently deleted. Use this endpoint to automate the archival of expired, cancelled, or superseded submissions as part of a document lifecycle management workflow.

    • Enter the unique identifier of the submission to archive in the Submission ID field. This is a required field.
    • Submission IDs can be sourced from the List Submissions or Get Submission source endpoints, or from other data in your Nexla pipeline that tracks submission lifecycle events.
    • Archiving a submission does not notify submitters. Any pending signing requests associated with the submission will become inaccessible to submitters after archival.

    Archived submissions can typically be restored or viewed in DocuSeal's archived submissions view. This operation is a soft delete—it does not permanently remove the submission or its associated signed documents. Refer to the DocuSeal API Reference for details on archival behavior.

    Create Template from PDF

    Creates a new reusable document template in DocuSeal from a PDF file with embedded field tags. Use this endpoint to programmatically build DocuSeal templates from PDF documents stored in your data pipeline, enabling automated template management as part of a document operations workflow.

    • The request body must include the PDF file (as a Base64-encoded string or a URL) and a name for the new template.
    • Fields within the template are defined using text tags embedded in the PDF, following the same syntax as the Create Submission from PDF endpoint.
    • Once created, the template is available in DocuSeal for use with the Create Submission endpoint. The API response includes the new template's ID, which can be used in subsequent submission creation requests.

    Programmatically created templates appear in the DocuSeal dashboard alongside manually created templates. Refer to the DocuSeal API Reference for the full list of supported request body fields and field tag syntax.

    Create Template from DOCX

    Creates a new document template in DocuSeal from a DOCX file with dynamic variable tags for content substitution at submission time. Use this endpoint to build reusable, data-driven document templates from Word files stored in your pipeline.

    • Dynamic variable tags are defined in the DOCX file using double-bracket syntax (e.g., [[variable_name]]). The values for these variables are supplied when submissions are created from the template.
    • The request body must include the DOCX file (as a Base64-encoded string or a URL) and a name for the new template.
    • The API response includes the new template's ID, which can be passed to the Create Submission endpoint to initiate signature requests from the new template.

    Create Template from HTML

    Generates a new reusable PDF document template in DocuSeal from HTML content, with pre-defined fillable and signable fields embedded via special HTML tags. Use this endpoint to programmatically create templates from dynamically generated HTML, allowing your data pipeline to produce fully structured e-signature templates without manually building them in the DocuSeal UI.

    • The request body must include the html string containing the document content and field tags, as well as a name for the new template.
    • Once created, the template is stored in DocuSeal and can be used with the Create Submission endpoint to initiate signing workflows. The API response includes the new template's ID.

    Merge Templates

    Merges two or more existing DocuSeal templates (including their documents and fields) into a single new combined template. Use this endpoint to programmatically combine related document templates—for example, merging a cover page template with a main agreement template to create a unified multi-document signing package.

    • The request body must include a template_ids array containing the IDs of the templates to merge (in the desired order) and a name for the resulting combined template.
    • Template IDs can be retrieved using the List Templates or Get Template source endpoints. The templates are merged in the order specified in the template_ids array.
    • The API response includes the new merged template's ID, which can be used to create submissions from the combined document.

    Update Template

    Updates an existing DocuSeal template's name or folder assignment by its unique ID. Use this endpoint to automate template organization—for example, renaming templates or moving them into specific folders as part of a document management workflow.

    • Enter the unique identifier of the template to update in the Template ID field. This is a required field.
    • The request body can include a new name for the template and/or a folder_name to move the template to a different folder in DocuSeal.
    • Template IDs can be retrieved using the List Templates or Get Template source endpoints.

    Update Template Documents

    Adds, removes, or replaces the documents within an existing DocuSeal template with new PDF, DOCX, or HTML content. Use this endpoint to programmatically update the document content of a template without recreating it from scratch—for example, refreshing the underlying PDF of a contract template when terms change.

    • Enter the unique identifier of the template whose documents should be updated in the Template ID field. This is a required field.
    • The request body must include the new document content (as a PDF, DOCX, or HTML file) and specify the update operation (add, replace, or remove documents). Existing field definitions may be affected depending on the documents being replaced.
    • Template IDs can be retrieved using the List Templates or Get Template source endpoints.

    Updating template documents may alter or remove existing field definitions if the new documents have different content or structure. Review the template in the DocuSeal dashboard after updating to verify that all fields are correctly positioned. Refer to the DocuSeal API Reference for the full specification of supported update operations.

    Archive Template

    Archives a DocuSeal document template by its unique ID, removing it from the active templates list. Use this endpoint to automate the retirement of outdated or superseded templates as part of a document lifecycle management workflow.

    • Enter the unique identifier of the template to archive in the Template ID field. This is a required field.
    • Archiving a template does not delete it permanently and does not affect submissions that were already created from the template. New submissions cannot be created from an archived template.
    • Template IDs can be retrieved using the List Templates or Get Template source endpoints.

    Clone Template

    Creates an exact copy of an existing DocuSeal template, including all its documents and field definitions. Use this endpoint to programmatically duplicate templates as a starting point for creating similar document types, or to create environment-specific copies of a template (e.g., a staging copy of a production template).

    • Enter the unique identifier of the template to clone in the Template ID field. This is a required field.
    • The API response includes the new cloned template's ID. The clone is created as a new independent template; changes to the clone do not affect the original.
    • Template IDs can be retrieved using the List Templates or Get Template source endpoints.

    Update Submitter

    Updates the details of an existing submitter record, pre-fills form field values on their behalf, and/or re-sends the signing invitation email. Use this endpoint to automate submitter management workflows—for example, updating a signer's email address, pre-populating fields with data from your pipeline, or re-sending an invitation that expired or was missed.

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

    • The request body can include any combination of the following updatable fields:

      • email: Updated email address for the submitter.
      • name: Updated display name for the submitter.
      • phone: Updated phone number (used for SMS-based signing invitations).
      • fields: An array of field objects with pre-filled values to populate the submitter's form fields before they sign.
      • send_email: Set to true to re-send the signing invitation email to the submitter's current (or updated) email address.
    • Submitter IDs can be retrieved using the List Submitters or Get Submission source endpoints.

    Pre-filling field values via the Update Submitter endpoint is particularly useful for automating document workflows where some fields can be populated from upstream data (e.g., customer name, address, or account number) before the signer reviews and signs the document. Refer to the DocuSeal API Reference for the field object structure required for pre-filling.

Configure Manually​

Docuseal destinations can be manually configured to send data to any valid DocuSeal API endpoint. Using manual configuration, you can also configure Nexla to automatically send the response received from the DocuSeal 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 Docuseal API from the Method pulldown menu. DocuSeal uses the following HTTP methods:

    • POST: For creating new resources (submissions, templates)
    • PUT: For replacing or fully updating existing resources (templates, submitters)
    • DELETE: For archiving submissions or templates

Data Format​

  1. Select the format in which the Nexset data will be sent to the Docuseal API from the Content Format pulldown menu. DocuSeal's REST API expects data in JSON format for all write operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the DocuSeal API endpoint to which you want to send the Nexset data in the 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)

    For update or archive operations on a specific resource, include the resource ID at the end of the URL (e.g., https://api.docuseal.com/submissions/12345 to archive submission 12345).

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 the X-Auth-Token authentication header here—this is handled automatically by Nexla based on your Docuseal credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Docuseal 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. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Docuseal 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—for example, capturing the submission ID and status returned by DocuSeal after each Create Submission request.

  • 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 Docuseal 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 Docuseal 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 Docuseal 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 DocuSeal, open the destination resource menu, and select Activate.

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