DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Form → Get Viewed

AI-generated

Overview

This node interacts with the DocuSeal API to work specifically with form events related to submitters. The "Get Viewed" operation under the "Form" resource retrieves data about forms that a particular submitter has viewed. This can be useful in scenarios where you want to track user engagement or monitor which forms have been accessed by specific users.

Practical examples include:

  • Monitoring if a submitter has viewed a contract or agreement before signing.
  • Triggering follow-up actions based on whether a form was viewed.
  • Generating reports on form interaction for compliance or auditing purposes.

Properties

Name Meaning
Submitter ID The unique numeric identifier of the submitter whose form view events you want to retrieve.

Output

The output is a JSON array containing the form view event data retrieved from the DocuSeal API for the specified submitter. Each item in the array corresponds to a form that the submitter has viewed, including relevant metadata provided by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the DocuSeal API using a valid API authentication token configured in n8n credentials.
  • The node depends on the internal helper function to make authenticated HTTP requests to the DocuSeal API endpoints.
  • No additional external services or environment variables are required beyond the API credential.

Troubleshooting

  • Common issues:

    • Invalid or missing Submitter ID will cause the API request to fail.
    • Network connectivity problems or incorrect API credentials will result in authentication errors.
    • If the submitter has no form viewed events, the output may be empty.

  • Error messages and resolutions:

    • "Failed to retrieve form viewed events" (or similar): Check that the Submitter ID is correct and exists in DocuSeal.
    • "Invalid API credentials": Verify that the API key/token is correctly set up in n8n credentials.
    • "Network error": Ensure that your server or environment has internet access and can reach the DocuSeal API endpoint.

Links and References

Discussion