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 the Wuzapi service sends event notifications to a specified URL.
Common scenarios include:
- Setting up a new webhook URL to receive WhatsApp event notifications.
- Updating existing webhook details such as the URL, subscribed events, or activation status.
- Retrieving current webhook configuration to verify or audit settings.
- Removing webhook configuration when no longer needed.
Practical example:
- A user wants to subscribe their application to incoming WhatsApp messages and read receipts by setting a webhook URL and selecting those event types.
- Later, they may update the webhook to add presence events or deactivate it temporarily without deleting.
Properties
| Name | Meaning |
|---|---|
| Update Fields | Collection of fields to update in the webhook configuration: |
| - Webhook URL | New webhook URL where events will be sent (string). |
| - Events | Event types to subscribe to. Options: All, Chat Presence, History Sync, Message, Presence, Read Receipt. Selecting "All" subscribes to all event types. |
| - Active | Boolean indicating whether the webhook should be active or inactive. |
Output
The node outputs JSON data representing the response from the Wuzapi API regarding webhook configuration. This includes details such as the webhook URL, subscribed events, and active status depending on the operation performed.
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) for managing webhook configurations. - Proper network connectivity and valid credentials are necessary for successful operations.
Troubleshooting
Common issues:
- Invalid or missing webhook URL format can cause API errors.
- Selecting no events or invalid event names may result in unexpected behavior.
- Network or authentication failures will prevent webhook configuration changes.
Error messages:
- Errors returned from the Wuzapi API will be included in the node's output if "Continue On Fail" is enabled.
- Typical errors might include authorization failures, invalid parameters, or server errors.
Resolutions:
- Verify the webhook URL is correctly formatted and accessible.
- Ensure the API key credential is valid and has required permissions.
- Confirm selected event types are supported by the API.
- Check network connectivity and firewall settings.
Links and References
- Wuzapi WhatsApp API Documentation (example placeholder link)
- n8n Webhook Node Concepts: https://docs.n8n.io/nodes/n8n-nodes-base.webhook/