Wuzapi Webhook icon

Wuzapi Webhook

Configure webhooks for Wuzapi WhatsApp API

Actions2

Overview

This node allows you to manage webhook configurations for the Wuzapi WhatsApp API. It supports operations to set, get, update, and delete webhook settings. Webhooks enable real-time event notifications from the WhatsApp API to a specified URL, making it useful for integrating WhatsApp messaging events into workflows.

Common scenarios include:

  • Setting up a webhook URL to receive incoming WhatsApp messages or presence updates.
  • Subscribing to specific event types such as message receipts or chat presence indicators.
  • Updating existing webhook configurations without removing them.
  • Removing webhook configurations when no longer needed.

Practical example:

  • You want to receive notifications whenever a new WhatsApp message arrives. Using this node, you configure a webhook URL and subscribe to the "Message" event type. Incoming messages will then be sent to your specified URL in real time.

Properties

Name Meaning
Webhook URL The URL that will receive webhook events.
Events Event types to subscribe to. Options include: All, Chat Presence, History Sync, Media Retry, Message, Presence, Read Receipt, Receipt. Selecting "All" subscribes to all event types.

Output

The node outputs JSON data representing the response from the Wuzapi WhatsApp API regarding webhook configuration. This includes details of the current webhook setup after performing the requested operation (get, set, update, or delete).

If an error occurs during execution and "Continue On Fail" is enabled, the output will contain an error field with the error message.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Wuzapi WhatsApp API.
  • The node uses HTTP requests to the /webhook endpoint of the Wuzapi API.
  • Proper network access to the Wuzapi API and the configured webhook URL is necessary.

Troubleshooting

  • Common issues:

    • Invalid or unreachable webhook URL: Ensure the URL is correct and publicly accessible.
    • Insufficient permissions or invalid API credentials: Verify the API key used has rights to manage webhooks.
    • Selecting incompatible or unsupported event types may cause errors.

  • Error messages:

    • Errors returned from the API are passed through and shown in the output under an error field if "Continue On Fail" is enabled.
    • Network or authentication errors typically indicate misconfiguration of credentials or connectivity issues.

To resolve errors:

  • Double-check the webhook URL format and availability.
  • Confirm API credentials are valid and have required permissions.
  • Review selected event types for correctness.

Links and References

Discussion