ZapSign

Overview

This node integrates with the ZapSign API to manage various digital document-related resources, including documents, signers, templates, background checks, partnerships, timestamps, and webhooks. Specifically, for the Webhook - Delete operation, it allows users to delete an existing webhook by its ID.

Deleting a webhook is useful when you no longer want to receive notifications or events from ZapSign for certain activities. For example, if you had set up a webhook to listen for document signing events but no longer need those notifications, you can use this operation to remove that webhook.

Practical scenarios include:

• Cleaning up unused or obsolete webhooks to reduce unnecessary event traffic.
• Managing webhook lifecycle programmatically within automation workflows.
• Revoking webhook access for security or organizational changes.

Properties

Output

The output is a JSON array where each element corresponds to the result of processing an input item. For the webhook deletion operation, the output JSON typically contains the response from the ZapSign API confirming the deletion status or any relevant data returned by the API.

Example output structure (simplified):

[
  {
    "success": true,
    "message": "Webhook deleted successfully",
    "id": "webhook-id-value"
  }
]

If the API returns an error, the node will throw an error unless configured to continue on failure, in which case the error message will be included in the output.

Dependencies

• Requires an API key credential for authenticating with the ZapSign API.
• Uses environment variables to determine the API base URL:
  • ZAPSIGN_API_BASE_URL_SANDBOX (optional sandbox URL)
  • ZAPSIGN_API_BASE_URL (production URL fallback)
• The node depends on internal helper functions for making HTTP requests and handling responses.

Troubleshooting

Common Issues

• Invalid Webhook ID: If the provided webhook ID does not exist or is malformed, the API may return an error.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures.
• Network Issues: Connectivity problems can prevent successful API calls.
• Permission Denied: The API user might lack permissions to delete webhooks.

Error Messages and Resolutions

• Error during deletion request: The node logs detailed error messages including the request options and API response. Review these logs to identify issues.
• API errors (e.g., 400 Bad Request): Usually indicate invalid parameters such as an incorrect webhook ID. Verify the webhook ID is correct.
• API errors (e.g., 401 Unauthorized or 403 Forbidden): Check that the API key credential is valid and has sufficient permissions.
• Timeouts or network errors: Ensure network connectivity and that the ZapSign API endpoint is reachable.

Links and References

• ZapSign API Documentation (general reference for API endpoints and webhook management)
• ZapSign Webhook Management (specific details about webhook creation and deletion)

This summary focuses exclusively on the Webhook - Delete operation as requested, based on static analysis of the provided source code and property definitions.