Wuzapi Webhook icon

Wuzapi Webhook

Configure webhooks for Wuzapi WhatsApp API

Actions2

Overview

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

Common scenarios include:

  • Setting up a new webhook URL to receive real-time WhatsApp events.
  • Updating existing webhook subscriptions to change the types of events received or modify the webhook URL.
  • Retrieving current webhook configuration details for auditing or debugging.
  • Removing webhook configurations when no longer needed.

Practical example:

  • A user wants to subscribe to incoming message events and read receipts from WhatsApp and have these events posted to their server endpoint. They can use this node to set the webhook URL and select those specific event types.
  • Later, if they want to add more event types like presence updates or temporarily disable the webhook, they can update the configuration using this node.

Properties

Name Meaning
Update Fields A collection of fields to update in the webhook configuration during the "Update" operation. It includes:
- Webhook URL: The new URL where webhook events will be sent.
- Events: The list of event types to subscribe to. Selecting "All" subscribes to every event type. Available event types include application state changes, call events, chat presence, message events, group info updates, pairing status, profile picture updates, privacy settings changes, QR code events, read receipts, connection errors, temporary bans, and many others.
- Active: Boolean flag indicating whether the webhook should be active (enabled) or not.

Output

The node outputs JSON data representing the response from the Wuzapi WhatsApp API regarding webhook configurations. This includes details such as the webhook URL, subscribed event types, and activation status.

The output structure is an array of objects, each corresponding to the webhook configuration returned or affected by the operation. For example, after an update operation, the output contains the updated webhook details.

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 Wuzapi API endpoints (/webhook) to perform operations.
  • Proper network connectivity and valid credentials are necessary.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or missing webhook URL format may cause API request failures.
    • Selecting no event types or invalid event values could result in incomplete or failed webhook configuration.
    • Network connectivity problems or incorrect API credentials will prevent successful communication with the Wuzapi API.
    • Attempting to update or delete a webhook that does not exist may return errors.

  • Error messages:

    • Errors returned from the API typically include descriptive messages about what went wrong (e.g., "Invalid webhook URL", "Unauthorized", "Not Found").
    • If the node is configured to continue on failure, error details are included in the output JSON under an error field.

  • Resolution tips:

    • Verify the webhook URL is reachable and correctly formatted (including HTTPS).
    • Ensure the API key credential is valid and has sufficient permissions.
    • Confirm the selected event types are supported and correctly spelled.
    • Check network access and firewall rules allowing outbound calls to the Wuzapi API.

Links and References

Discussion