Actions37
- Message Actions
- Media Actions
- Contact Actions
- Group Actions
- Instance Actions
- Webhook Actions
Overview
This node integrates with the Uazapi WhatsApp API to manage webhook configurations for a WhatsApp instance. Specifically, the Get Webhook operation retrieves the current webhook URL and settings configured for the WhatsApp instance.
Use cases include:
- Verifying the webhook URL currently set to receive WhatsApp event notifications.
- Auditing or debugging webhook configurations in automated workflows.
- Ensuring that your WhatsApp integration is correctly set up to receive incoming messages or status updates via webhooks.
Example scenario: Before setting a new webhook URL, you might want to retrieve the existing webhook configuration to confirm what is currently active.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters to customize the request. Includes: |
| - Reply to Message ID | ID of a message to reply to (string) |
| - Delay (seconds) | Delay before sending a message (number) |
| - Disable Link Preview | Whether to disable link previews in messages (boolean) |
| - Mention Users | Comma-separated phone numbers to mention in the message (string) |
Note: For the Get Webhook operation, the "Additional Fields" collection is available but typically not required.
Output
The node outputs a JSON object containing the response from the Uazapi service about the webhook configuration. The structure generally includes details such as:
- The webhook URL currently set for the WhatsApp instance.
- Status or metadata related to the webhook setup.
Output example (conceptual):
{
"webhook": "https://your-webhook-url.com/receive",
"status": "active"
}
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential and authentication token for the Uazapi WhatsApp API.
- Needs the WhatsApp instance ID to identify which instance's webhook to query.
- The node makes HTTP requests to the Uazapi API endpoint, proxied through
https://n8ntools.io/api/v1/proxy/uazapi. - Proper network connectivity and valid credentials are necessary.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect instance ID may result in errors or empty webhook data.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Authentication errors: Check that the API key and token are correctly configured.
- "Unknown resource" error: Ensure the resource parameter is set to "webhook".
- HTTP errors from the API: Verify the Uazapi service status and your internet connection.
Resolution tips:
- Double-check all credential inputs.
- Confirm the instance ID matches your WhatsApp instance.
- Test the webhook URL separately to ensure it is reachable.
Links and References
- Uazapi Official Documentation (for detailed API usage)
- WhatsApp Business API Webhooks
- n8n Community Forum and Docs for custom node usage and troubleshooting