DocuSeal

Overview

This n8n node integrates with the DocuSeal API, enabling users to create documents, manage templates, and handle submissions within their automated workflows. The node is highly versatile, supporting operations such as creating new document submissions, retrieving or archiving submissions, managing templates, and handling submitters.

Common scenarios where this node is beneficial:

• Automating contract or agreement signing processes.
• Managing document templates and tracking submission statuses.
• Integrating e-signature workflows into business automation pipelines.

Practical examples:

• Automatically generating a new NDA for each new client and sending it for signature.
• Fetching all completed submissions for reporting or compliance purposes.
• Archiving old submissions based on workflow logic.

Properties

Details:

• Environment:
  • Type: Options (dropdown)
  • Options: Production, Test
  • Description: Selects whether the node operates against the live (production) or sandbox (test) DocuSeal environment.

Output

The node outputs data in the json field. The structure of the output depends on the selected resource and operation, but generally reflects the response from the DocuSeal API. Typical output includes:

• For "Get" operations: A single object representing the requested entity (e.g., a template, submission, or submitter).
• For "List" operations: An array of objects, each representing an item (e.g., list of submissions).
• For "Create Submission": The created submission's details, including IDs, status, and any relevant metadata.
• For "Archive" or "Update" operations: Confirmation of the action or the updated entity.

Example output for a successful operation:

{
  "id": 123,
  "status": "completed",
  "template_id": 456,
  "submitters": [
    {
      "email": "user@example.com",
      "role": "Signer"
    }
  ],
  "fields": {
    "field1": "value1"
  },
  "created_at": "2024-06-01T12:00:00Z"
}

If an error occurs and "Continue On Fail" is enabled, the output will be:

{
  "error": "Error message here"
}

Dependencies

• External Service: Requires access to the DocuSeal API.
• API Credentials: You must configure DocuSeal API credentials in n8n under the name docusealApi.
• n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

Common issues:

• Invalid Credentials: If the API key is missing or incorrect, authentication errors will occur.
• Missing Required Fields: For example, when creating a submission, if the "Submitters" array is empty or improperly formatted, the node will throw an error indicating that at least one valid submitter is required.
• Malformed JSON: If fields like "submissionData" are not valid JSON strings, parsing errors will be thrown.
• API Errors: Any errors returned by the DocuSeal API (such as invalid IDs or permissions issues) will be surfaced as node errors.

Common error messages:

• "Submitters parameter must be a valid array with at least one submitter object"
  Resolution: Ensure you provide a non-empty array of submitter objects, each with valid "email" and "role" properties.
• "Invalid submitter at index X: Each submitter must be an object with non-empty 'email' and 'role' string properties."
  Resolution: Check your submitter data for missing or empty "email"/"role" fields.
• "Error creating submission: ..."
  Resolution: Review the error message for specifics; check your input data and API credentials.

Links and References

• DocuSeal Website
• n8n Documentation
• DocuSeal API Reference