Actions23
- Template Actions
- AI Tool Actions
- Form Actions
- Submission Actions
- Submitter Actions
Overview
This node allows you to create a new document submission based on an existing template in DocuSeal. A submission represents a document instance that is sent out to one or more submitters (people who will sign or fill the document). You can pre-fill fields in the document, specify submitters with their roles and contact details, and configure various options such as notification preferences, signing order, expiration, and custom messages.
Common scenarios where this node is useful include automating contract signing workflows, sending forms for approval or data collection, and managing multi-party document signing processes. For example, you could automatically generate a contract from a template, assign it to clients and witnesses for signatures, pre-fill known information, and notify all parties via email or SMS.
Properties
| Name | Meaning |
|---|---|
| Template | How to select the template: either "From List" (choose from dropdown) or "By ID" (enter template ID directly). |
| Template Name or ID | Select the template from a dropdown list of available templates (shown if "From List" is chosen). |
| Template ID | Enter the template ID directly as a string (shown if "By ID" is chosen). |
| Submitters | One or more people who will sign or fill the document. Each submitter requires an email and role (e.g., Signer, Client). Additional optional fields include name, phone, external ID, metadata, completion status, notification preferences, and pre-filled field values. |
| Field Values Input Mode | Choose how to define field values to pre-fill in the document: "Individual Fields" (set each field separately) or "JSON Object" (define all fields as a JSON object). |
| Field Values | When using "Individual Fields" mode, specify multiple field name-value pairs to pre-fill document fields. |
| Field Values JSON | When using "JSON Object" mode, provide a JSON object mapping field names to their values for pre-filling. |
| Additional Options | Various optional settings including: - BCC Completed: Email address to BCC when submission completes. - Completed Redirect URL: URL to redirect submitters after completion. - Expire At: Submission expiration datetime. - External ID: Custom identifier for the submission. - Message: Custom email subject and body with variables. - Metadata: Additional JSON metadata. - Order: Signing order ("Random (All at Once)" or "Sequential"). - Reply To: Reply-to email address. - Send Email: Global toggle for email notifications. - Send SMS: Global toggle for SMS notifications. |
Output
The node outputs the JSON response returned by the DocuSeal API upon creating the submission. This typically includes details about the created submission such as its unique ID, status, associated template ID, submitters, field values, URLs for signing, timestamps, and any metadata.
If the operation fails, the output may contain an error message describing the issue.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the DocuSeal API.
- Requires an API authentication credential configured in n8n (an API key or token).
- The node uses helper functions to prepare submitter arrays and field values, and to format dates.
- The node expects valid template IDs and submitter information.
- If using file URLs or binary data for other operations, proper validation and preparation are required (not applicable here).
Troubleshooting
- At least one submitter is required: The node throws an error if no submitters are provided. Ensure you add at least one submitter with a valid email and role.
- Failed to build field values: Errors in formatting or providing field values (either individual or JSON) will cause failure. Verify the field names and JSON syntax.
- Invalid template ID: Using an incorrect or non-existent template ID will result in API errors. Confirm the template exists and the ID is correct.
- API request failures: Network issues, invalid credentials, or API limits can cause errors. Check your API key and network connectivity.
- Date formatting: The expiration date must be a valid datetime; otherwise, the API may reject the request.
- Notification toggles: If emails or SMS are not sent, verify the global and per-submitters notification flags.
Links and References
- DocuSeal API Documentation (for detailed API endpoints and parameters)
- n8n Expressions Documentation (for dynamic parameter expressions)
- DocuSeal Templates Guide (to understand template management)
- DocuSeal Submissions Guide (for submission lifecycle and options)