Overview
This node acts as a trigger for workflows based on events from the ZapSign electronic signature platform. It listens to various document and signer-related events such as when a document is created, sent, viewed, signed, completed, cancelled, expired, or when signers are added, sign, or decline.
Common scenarios where this node is beneficial include:
- Automating follow-up actions after a document is fully signed.
- Notifying teams when a document is sent or viewed.
- Tracking signer activity in real-time.
- Filtering workflows to respond only to specific documents, signers, or brands.
For example, you could use this node to start a workflow that sends a thank-you email once all signers have completed signing a contract, or to update a CRM system when a particular signer signs a document.
Properties
| Name | Meaning |
|---|---|
| Events | The ZapSign events to listen for. Options include: Document Created, Sent, Viewed, Signed, Completed, Cancelled, Expired; Signer Added, Signed, Declined. Default is Document Completed. |
| Document Filter | Optional filters to restrict triggering: - Document ID: Only trigger for a specific document. - Signer Email: Only trigger for a specific signer’s email. - Brand ID: Only trigger for a specific brand. |
Output
The node outputs JSON data representing the event payload received from ZapSign, enriched with metadata:
event: The event type string (e.g., "document.completed").data: The detailed event data object containing information about the document, signer, etc.metadata: An added object including:event_type: The event type.received_at: ISO timestamp of when the webhook was received.webhook_source: Fixed string"zapsign"indicating the source.
This output allows downstream nodes to access all relevant event details for further processing.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- Needs proper configuration of the webhook URL in ZapSign via the node’s webhook management methods.
- Supports both sandbox and production environments depending on the credential configuration.
Troubleshooting
- Webhook registration failure: If the node cannot register the webhook with ZapSign, ensure the API key is valid and has permissions to manage webhooks.
- Event not triggering: Verify that the event types selected in the node match those sent by ZapSign. Also check that any filters (Document ID, Signer Email, Brand ID) correctly correspond to the incoming event data.
- Invalid webhook payload: If the webhook receives malformed data without expected
eventordatafields, the node will respond with a 400 error. Confirm ZapSign is configured to send correct payloads. - Permission errors: Ensure the API key used has access to the environment (sandbox or production) matching the node’s configuration.
Links and References
- ZapSign API Documentation (for webhook event details and API usage)
- n8n Webhook Trigger Documentation (general concepts on webhook triggers in n8n)