Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
This node integrates with the ZapSign API to manage electronic signature workflows and related resources. Specifically, for the Webhook - Create operation, it allows users to register a webhook URL that will receive notifications about specified events occurring within their ZapSign account.
Use cases include:
- Automatically triggering workflows when documents are signed, created, deleted, or refused.
- Receiving alerts on email delivery failures (bounces).
- Integrating ZapSign event notifications into other systems via webhooks.
For example, you can create a webhook to listen for all document-related events and update your CRM or database whenever a document is signed or deleted.
Properties
| Name | Meaning |
|---|---|
| Webhook URL | The URL endpoint where webhook notifications will be sent. |
| Event Type | The type of event to listen for. Options: |
| - All Document Events (Default): created, signed, deleted, refused | |
| - Document Signed | |
| - Document Created | |
| - Document Deleted | |
| - Document Refused | |
| - Email Bounce (email delivery failure) |
Output
The node outputs an array of JSON objects representing the response from the ZapSign API after creating the webhook. This typically includes details such as the webhook ID, URL, event types subscribed to, and status information confirming successful creation.
No binary data output is involved in this operation.
Dependencies
- Requires an active ZapSign API credential configured in n8n for authentication.
- Uses environment variables to determine the API base URL (
ZAPSIGN_API_BASE_URL_SANDBOXfor sandbox orZAPSIGN_API_BASE_URLfor production). - Relies on network connectivity to the ZapSign API endpoints.
Troubleshooting
Common issues:
- Invalid or unreachable webhook URL may cause webhook creation to fail or webhook notifications not to be delivered.
- Specifying an unsupported event type could result in unexpected behavior or no notifications.
- Missing or invalid API credentials will prevent successful API calls.
Error handling:
- If the API request fails, the node logs detailed error messages including request options.
- Errors during webhook creation are thrown and can be caught by n8n’s error handling mechanisms.
- Users should verify the webhook URL is publicly accessible and correctly formatted.
- Check that the API key credential has sufficient permissions to create webhooks.
Links and References
- ZapSign API Documentation (for webhook and event details)
- n8n documentation on creating custom nodes
- General webhook best practices: ensure HTTPS URLs, handle retries, and validate incoming requests.
This summary focuses exclusively on the "Webhook" resource with the "Create" operation as requested.