ZuckZapGo Webhook icon

ZuckZapGo Webhook

Configure webhooks for ZuckZapGo WhatsApp API
Join our community

Actions2

Overview

This node manages webhook configurations for the ZuckZapGo WhatsApp API. It allows users to create, update, retrieve, or delete webhook settings that define how and when events from the WhatsApp API are sent to a specified URL.

Common scenarios include:

  • Setting up a new webhook URL to receive real-time WhatsApp event notifications.
  • Updating an existing webhook's URL, subscribed event types, or activation status.
  • Retrieving current webhook configuration details for monitoring or auditing.
  • Removing webhook configurations when no longer needed.

Practical example:

  • A user wants to subscribe to incoming message events and read receipts by setting a webhook URL where these events will be posted.
  • Later, they decide to update the webhook to also listen for presence updates and deactivate the webhook temporarily.
  • They can use this node to perform all these operations programmatically within an n8n workflow.

Properties

Name Meaning
Update Fields Collection of fields to update in the webhook configuration during the "Update" operation. Contains:
• Webhook URL: New URL to receive webhook events.
• Events: List of event types to subscribe to. Options include "All", "App State", "Blocklist", "Call Accept", "Chat Presence", "Message", "Read Receipt", "Receipt", "Temporary Ban", and many more detailed WhatsApp-related event types.
• Active: Boolean indicating whether the webhook should be active or not.

Output

The node outputs JSON data representing the response from the ZuckZapGo WhatsApp API related to webhook management. The structure depends on the operation performed:

  • For Get: Returns the current webhook configuration including URL, subscribed events, and active status.
  • For Set and Update: Returns confirmation and details of the updated webhook configuration.
  • For Delete: Returns confirmation of webhook removal.
  • In case of errors (if continueOnFail is enabled), returns an object with an error field containing the error message.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the ZuckZapGo WhatsApp API.
  • The node uses HTTP requests to the /webhook endpoint of the ZuckZapGo API.
  • Proper network access to the ZuckZapGo API service must be configured.
  • The webhook URL provided must be publicly accessible to receive event callbacks.

Troubleshooting

  • Common issues:

    • Invalid or unreachable webhook URL causing failures in webhook setup.
    • Insufficient permissions or invalid API credentials leading to authentication errors.
    • Selecting incompatible or unsupported event types may cause API errors.
    • Network connectivity problems between n8n and the ZuckZapGo API.

  • Error messages:

    • Errors returned from the API will be included in the output if "Continue On Fail" is enabled.
    • Typical errors include authentication failures, invalid parameters, or server errors.
    • To resolve, verify API credentials, ensure webhook URLs are correct and reachable, and confirm selected event types are valid.

Links and References

Discussion