ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions15

Overview

This node integrates with the ZapSign API to manage digital signature workflows. Specifically, the Webhook - Create operation allows users to register a webhook URL that will receive notifications for specified document or signer events from ZapSign.

Common scenarios include:

  • Automatically triggering downstream processes when a document is signed or completed.
  • Keeping external systems synchronized by receiving real-time updates about document lifecycle events.
  • Monitoring signer actions such as signing completion.

For example, you might create a webhook to notify your CRM system whenever a document is fully signed, enabling automated status updates or follow-up actions.

Properties

Name Meaning
Webhook URL The URL endpoint where ZapSign will send webhook notifications.
Events The list of event types to listen for. Possible values:
- Document Created
- Document Sent
- Document Signed
- Document Completed
- Document Cancelled
- Signer Signed

Output

The output JSON contains the response from the ZapSign API after creating the webhook. This typically includes details such as the webhook ID, the registered URL, and the subscribed events.

Example output structure (simplified):

{
  "id": "webhook-id",
  "url": "https://your-webhook-url.com/endpoint",
  "events": [
    "document.completed",
    "document.signed"
  ],
  "created_at": "2024-01-01T12:00:00Z"
}

No binary data is produced by this operation.

Dependencies

  • Requires an active ZapSign API key credential configured in n8n for authentication.
  • Internet access to call the ZapSign API endpoints.
  • The webhook URL must be publicly accessible to receive incoming HTTP POST requests from ZapSign.

Troubleshooting

  • Invalid Webhook URL: Ensure the webhook URL is correctly formatted and publicly reachable. ZapSign will not deliver events if the URL is unreachable.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Event Subscription Issues: Confirm that the selected events are supported by ZapSign and spelled correctly.
  • API Rate Limits: If many webhooks are created rapidly, you may hit API rate limits; check ZapSign's API usage policies.
  • Error Messages: The node throws errors if the API request fails. Common messages include network errors, invalid parameters, or unauthorized access. Review the error message and verify credentials and input parameters.

Links and References

Discussion