6.5 KiB
n8n-nodes-zapsign
This is an n8n community node that lets you use ZapSign's digital signature API in your n8n workflows.
ZapSign is a digital signature platform that enables you to create, send, and manage legally binding electronic signatures for your documents.
n8n is a fair-code licensed workflow automation platform.
Installation
Follow the installation guide in the n8n community nodes documentation.
Community Nodes (Recommended)
- Go to Settings > Community Nodes.
- Select Install.
- Enter
n8n-nodes-zapsignin Enter npm package name. - Agree to the risks of using community nodes.
- Select Install.
After installing the node, you can use it like any other node in n8n.
Manual Installation
To get started install the package in your n8n root directory:
npm install n8n-nodes-zapsign
For Docker-based deployments add the following line before the font installation command in your n8n Dockerfile:
RUN cd /usr/local/lib/node_modules/n8n && npm install n8n-nodes-zapsign
Credentials
You'll need to set up ZapSign API credentials to use this node:
- Sign up for a ZapSign account
- Go to your ZapSign dashboard
- Navigate to API settings and generate an API key
- In n8n, create new ZapSign API credentials with:
- API Key: Your ZapSign API key
- Environment: Choose between Production or Sandbox
Operations
ZapSign Node
The ZapSign node supports the following resources and operations:
Document
- Create: Upload and create a new document
- Get: Retrieve document details
- Get All: List all documents
- Send: Send document for signature
- Cancel: Cancel a document
- Download: Download a signed document
Signer
- Add: Add a signer to a document
- Get All: Get all signers of a document
- Remove: Remove a signer from a document
- Update: Update signer information
Template
- Get All: List all available templates
- Create Document From Template: Create a new document from a template
Webhook
- Create: Create a webhook for event notifications
- Get All: List all webhooks
- Delete: Delete a webhook
ZapSign Trigger Node
The ZapSign Trigger node allows you to start workflows when ZapSign events occur:
Supported Events
- Document Created: When a document is created
- Document Sent: When a document is sent for signature
- Document Viewed: When a document is viewed by a signer
- Document Signed: When a document is signed by any signer
- Document Completed: When all signers have signed the document
- Document Cancelled: When a document is cancelled
- Document Expired: When a document expires
- Signer Added: When a signer is added to a document
- Signer Signed: When a specific signer signs
- Signer Declined: When a signer declines to sign
Example Workflows
Document Signature Workflow
- HTTP Request: Receive document upload request
- ZapSign: Create document with uploaded file
- ZapSign: Add signers to the document
- ZapSign: Send document for signature
- ZapSign Trigger: Wait for document completion
- Email: Send notification when document is signed
Template-Based Document Creation
- Schedule Trigger: Run daily
- Google Sheets: Get contract data
- ZapSign: Create document from template
- ZapSign: Add signers from spreadsheet
- ZapSign: Send for signature
- Slack: Notify team
Webhook Event Processing
- ZapSign Trigger: Listen for document events
- Switch: Route based on event type
- Database: Update document status
- Email: Send appropriate notifications
Authentication Methods
ZapSign supports multiple authentication methods for signers:
- Email: Simple email verification
- SMS: SMS code verification
- WhatsApp: WhatsApp code verification
Additional security features:
- Document Authentication: Require ID document upload
- Facial Recognition: Verify identity through facial recognition
- Biometric GOV+: Government database validation (Brazil)
API Endpoints Structure
The node assumes the following ZapSign API structure:
Base URL: https://api.zapsign.co (Production)
https://sandbox.api.zapsign.co (Sandbox)
Documents:
- POST /v1/documents - Create document
- GET /v1/documents - List documents
- GET /v1/documents/{id} - Get document
- POST /v1/documents/{id}/send - Send document
- POST /v1/documents/{id}/cancel - Cancel document
- GET /v1/documents/{id}/download - Download document
Signers:
- POST /v1/documents/{id}/signers - Add signer
- GET /v1/documents/{id}/signers - List signers
- PUT /v1/documents/{id}/signers/{email} - Update signer
- DELETE /v1/documents/{id}/signers/{email} - Remove signer
Templates:
- GET /v1/templates - List templates
- POST /v1/documents/from-template - Create from template
Webhooks:
- POST /v1/webhooks - Create webhook
- GET /v1/webhooks - List webhooks
- DELETE /v1/webhooks/{id} - Delete webhook
Error Handling
The node includes comprehensive error handling:
- Authentication errors: Invalid API key or expired tokens
- Rate limiting: Automatic retry with exponential backoff
- Validation errors: Missing required fields or invalid data
- Network errors: Connection timeouts and retries
All errors are properly formatted and include helpful context for debugging.
Compatibility
- n8n v0.187.0 and above
- Node.js v18.10 and above
Resources
Support
For support with this community node:
- Check the ZapSign API documentation
- Review the n8n community forum
- Open an issue on this repository
For ZapSign-specific questions, contact ZapSign support at support@zapsign.co
License
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Changelog
1.0.0
- Initial release
- Support for Document, Signer, Template, and Webhook operations
- ZapSign Trigger node for webhook events
- Complete authentication and error handling
- Support for both Production and Sandbox environments