DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

This node interacts with the DocuSeal API to work with form-related events for a specified submitter. Specifically, the "Get Started" operation retrieves information about forms that a particular submitter has started. This can be useful in scenarios where you want to track user engagement or progress on forms within your document workflow system.

Practical examples include:

  • Monitoring which forms a user has begun filling out.
  • Triggering follow-up actions based on whether a submitter has started a form.
  • Integrating form start events into broader automation workflows for document management.

Properties

Name Meaning
Submitter ID The numeric ID of the submitter whose form start events you want to retrieve. This is required.

Output

The output is a JSON array containing the data returned by the DocuSeal API endpoint /submitters/{submitterId}/form_started. This typically includes details about the forms that the specified submitter has started. The exact structure depends on the API response but generally represents form event metadata related to the submitter.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the DocuSeal API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to DocuSeal endpoints.
  • No additional external dependencies are needed beyond the configured API access.

Troubleshooting

  • Invalid Submitter ID: If the submitter ID does not exist or is invalid, the API may return an error or empty result. Verify the submitter ID before running the node.
  • API Request Failures: Network issues or incorrect API credentials will cause request failures. Ensure the API key credential is valid and network connectivity to DocuSeal is available.
  • Error Messages: Errors from the API are wrapped and thrown as node operation errors with messages like Failed to retrieve form started events: <error message>. Check the error details for troubleshooting.
  • Continue On Fail: If enabled, the node will output error messages in the JSON output instead of stopping execution.

Links and References

Discussion