Overview
This node manages webhook configurations for the DinastiAPI WhatsApp API. It allows users to create, update, retrieve, or delete webhook settings that control how and when events from the WhatsApp API are sent to a specified URL.
Common scenarios include:
- Setting up a new webhook URL to receive real-time WhatsApp event notifications.
- Updating existing webhook configurations to change subscribed event types or activate/deactivate the webhook.
- Retrieving current webhook settings for auditing or debugging purposes.
- Removing webhook configurations when they are no longer needed.
Practical example:
- A user wants to receive notifications about incoming messages and read receipts in their application. They use this node to set a webhook URL and subscribe to the "Message" and "Read Receipt" events.
- Later, they decide to add more event types or change the webhook URL; they use the update operation to modify these settings without deleting and recreating the webhook.
Properties
| Name | Meaning |
|---|---|
| Update Fields | Collection of fields to update in the webhook configuration during the "Update" operation. Contains: - Webhook URL: New webhook URL to receive events. - Events: List of event types to subscribe to. Selecting "All" subscribes to all event types. Available event options include a wide range such as "App State", "Blocklist Change", "Call Accept", "Chat Presence", "Message", "Read Receipt", "Temporary Ban", and many others related to WhatsApp API events. - Active: Boolean indicating whether the webhook should be active (enabled) or not. |
Output
The node outputs JSON data representing the response from the DinastiAPI WhatsApp API regarding webhook configurations. The structure depends on the operation performed:
- Get: Returns the current webhook configuration details including URL, subscribed events, and status.
- Set: Returns confirmation and details of the newly configured webhook.
- Update: Returns updated webhook configuration details reflecting changes made.
- Delete: Returns confirmation of webhook removal.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the DinastiAPI WhatsApp API.
- The node uses HTTP requests to the DinastiAPI endpoints (
/webhook) to manage webhook configurations. - Proper network access to the DinastiAPI service is necessary.
- The user must configure the credential with appropriate permissions to manage webhooks.
Troubleshooting
Common issues:
- Invalid or missing webhook URL can cause API errors.
- Subscribing to unsupported event types may result in failures.
- Network connectivity problems can prevent successful API calls.
- Attempting to update or delete a webhook that does not exist will cause errors.
Error messages and resolutions:
- "Invalid webhook URL": Ensure the URL is correctly formatted and accessible.
- "Unauthorized" or authentication errors: Verify that the API key credential is valid and has required permissions.
- "Event type not supported": Check that selected event types are valid according to the available options.
- "Webhook not found": Confirm that the webhook exists before attempting update or delete operations.
Links and References
- DinastiAPI WhatsApp API Documentation (example placeholder link)
- Webhook concepts and best practices: https://developer.mozilla.org/en-US/docs/Web/API/Webhooks
- n8n documentation on creating custom nodes: https://docs.n8n.io/integrations/creating-nodes/