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 its configuration set on the WhatsApp instance.
Use cases include:
- Verifying which webhook URL is currently configured to receive WhatsApp event notifications.
- Debugging or auditing webhook settings before updating or deleting them.
- Automating workflows that depend on dynamic webhook management.
For example, you might use this node to programmatically check if your webhook URL is correctly set after deployment or before sending messages triggered by webhook events.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters: • Reply to Message ID (string) • Delay (seconds) (number) • Disable Link Preview (boolean) • Mention Users (comma-separated phone numbers as string) |
Note: For the Get Webhook operation, the "Additional Fields" collection is available but typically not required or used.
Output
The node outputs a JSON object containing the current webhook configuration details retrieved from the Uazapi service. The structure generally includes:
- The webhook URL currently set for the WhatsApp instance.
- Any additional metadata related to the webhook configuration.
Example output snippet (simplified):
{
"webhook": "https://your-webhook-url.com/receive",
"status": "active",
"instance": "your-instance-id"
}
No binary data is produced by this operation.
Dependencies
- Requires an active Uazapi WhatsApp API account.
- Needs credentials including:
- An API key credential for authenticating requests to the proxy service.
- API token and instance ID for the WhatsApp instance.
- The node sends HTTP requests via a proxy endpoint (
https://n8ntools.io/api/v1/proxy/uazapi) which requires the API key. - Proper network access to the proxy and Uazapi endpoints is necessary.
Troubleshooting
Common issues:
- Invalid or missing credentials will cause authentication failures.
- Network connectivity problems may prevent reaching the proxy or Uazapi services.
- If the WhatsApp instance is not properly initialized or connected, webhook information may be unavailable.
Error messages:
- Authentication errors usually indicate invalid API tokens or keys; verify and update credentials.
- "Unknown resource" error indicates a misconfiguration in the Resource parameter.
- HTTP errors from the proxy or Uazapi service should be checked for rate limits or service outages.
Resolution tips:
- Double-check all credential values and ensure they are current.
- Confirm the WhatsApp instance is active and linked to your Uazapi account.
- Test network connectivity to the proxy URL outside n8n to isolate issues.
Links and References
- Uazapi Official Documentation (for WhatsApp API details)
- n8n Documentation (for general node usage and credential setup)
- WhatsApp Business API Overview (background on WhatsApp messaging APIs)