Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
This node enables managing webhooks for a WhatsApp API integration called SparkBot. Specifically, the "Update Webhook" operation allows users to modify an existing webhook's configuration, such as its name, URL, subscribed event types, and optionally restrict it to a specific WhatsApp device.
Use cases include:
- Changing the endpoint URL where webhook notifications are sent.
- Updating which event types trigger webhook calls (e.g., new inbound messages, message updates).
- Renaming the webhook for better identification.
- Limiting webhook notifications to a particular WhatsApp device.
Practical example: If your application needs to change the webhook URL after deployment or adjust which events it listens to, this operation lets you update those settings without deleting and recreating the webhook.
Properties
| Name | Meaning |
|---|---|
| Webhook ID | The unique identifier of the webhook to update. |
| Webhook Name | Internal name for the webhook (max 30 characters). |
| Webhook URL | Publicly accessible endpoint URL that will receive HTTP POST requests when specified events occur. |
| Event Types | List of event types to be notified by this webhook. Options include: - New Inbound Message - New Outbound Message - Outbound Message Sent - Outbound Message Delivery Status - Outbound Message Failed - Message Updated - Message Reaction - Channel Message Received - Status Update - Group Update - Chat Update - Contact Update - WhatsApp Session Status |
| Device ID (Optional) | Restrict webhook notifications to a specific WhatsApp device identified by a 24-character hexadecimal ID. |
Output
The node outputs JSON data representing the updated webhook object returned from the API. This typically includes details such as the webhook ID, name, URL, subscribed events, and device restriction if set.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- The node depends on the SparkBot API service being available and reachable.
- The webhook URL must be publicly accessible to receive HTTP POST requests from the service.
Troubleshooting
- Invalid Webhook ID: If the provided webhook ID does not exist or is malformed, the API will return an error. Verify the ID before updating.
- Invalid URL: The webhook URL must be publicly accessible and valid. Errors may occur if the URL is unreachable or improperly formatted.
- Event Types Missing or Invalid: At least one valid event type must be selected. Ensure the event types conform to the allowed options.
- Device ID Issues: If restricting to a device, ensure the device ID is correct and corresponds to an active WhatsApp device.
- API Authentication Failures: Check that the API key credential is correctly configured and has necessary permissions.
- Continue On Fail: If enabled, errors per item will be returned in the output JSON under an
errorfield instead of stopping execution.
Links and References
- SparkBot WhatsApp API Documentation (hypothetical link)
- Webhook Concepts and Best Practices
- n8n Documentation on Creating Custom Nodes