DocuSeal

Overview

The DocuSeal - Submission: Get operation retrieves detailed information about a specific document submission from the DocuSeal platform, using its unique Submission ID. This is useful for automating workflows where you need to fetch the status, metadata, or content of a previously created submission—such as tracking document signing progress, auditing submissions, or integrating with other systems.

Example scenarios:

• Checking if a contract has been signed by all parties.
• Fetching submission details to display in a dashboard.
• Triggering follow-up actions based on the submission's current state.

Properties

Output

The node outputs a single json object containing all available data for the requested submission. The structure typically includes:

{
  "id": 123,
  "template_id": 456,
  "status": "completed",
  "created_at": "2024-06-01T12:34:56Z",
  "updated_at": "2024-06-02T09:00:00Z",
  "submitters": [
    {
      "email": "user@example.com",
      "role": "Signer",
      // ...other submitter fields
    }
  ],
  "fields": {
    "field1": "value1"
    // ...other field values
  },
  "preferences": {
    // ...submission preferences
  },
  // ...additional metadata fields
}

Note: The exact output fields depend on the DocuSeal API response for the given Submission ID.

Dependencies

• External Service: Requires access to the DocuSeal API.
• API Credentials: You must configure valid DocuSeal API credentials (docusealApi) in n8n.
• Environment Selection: Make sure to select the correct environment (Production or Test) as per your use case.

Troubleshooting

Common Issues:

• Invalid Submission ID: If the provided Submission ID does not exist, the node will return an error message such as "Submission not found" or similar.
• Authentication Errors: Missing or incorrect API credentials will result in authentication errors.
• Environment Mismatch: Selecting the wrong environment may cause the node to not find the expected submission.

Error Handling:

• If an error occurs and "Continue On Fail" is enabled, the node will output an object like { "error": "Error message here" } in the json field.
• Otherwise, the workflow execution will stop and display the error.

Links and References

• DocuSeal Documentation
• n8n Docs: Using Credentials
• n8n Docs: Error Handling