Overview
This node creates a new WhatsApp client connection using the WbizTool service. It is designed to register a WhatsApp number with WbizTool, optionally associating a webhook URL for receiving notifications related to that WhatsApp client.
Common scenarios where this node is useful include:
- Automating the setup of WhatsApp clients in bulk by providing multiple WhatsApp numbers.
- Integrating WhatsApp messaging capabilities into workflows by programmatically creating client connections.
- Setting up webhook URLs to receive real-time updates or events from WhatsApp via WbizTool.
For example, a user can input a WhatsApp number and an optional webhook URL, and the node will create the client on WbizTool, returning the client ID and status. This enables further automation such as sending messages or monitoring WhatsApp activity.
Properties
| Name | Meaning |
|---|---|
| WhatsApp Number | The WhatsApp phone number to connect. Must be 10 to 15 digits, can include "+" or spaces. |
| Webhook URL | (Optional) URL to receive notifications or callbacks related to the WhatsApp client. |
Output
The node outputs an array of JSON objects, each corresponding to an input item processed. Each output JSON contains:
success: Boolean indicating if the creation was successful.status: Numeric status code returned by the WbizTool API.message: Message string from the API response.whatsappClientId: The unique identifier of the created WhatsApp client (if successful).response: The full raw response object from the WbizTool API.input: Object echoing back the normalized input values (whatsappNumberandwebhookUrl).client: Object summarizing the created client details including:whatsappClientIdwhatsappNumberwebhookUrlcreatedAt: ISO timestamp of creation timestatus: Always set to"created"upon success
If the node encounters an error and is configured to continue on failure, it outputs:
success: falseerror: Error message describing what went wrong
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating with the WbizTool API.
- Uses the WbizTool API endpoint
/whatsapp-client/create/to create WhatsApp clients. - No additional environment variables are required beyond the API credentials.
Troubleshooting
- Empty WhatsApp Number: If the WhatsApp number input is empty or only whitespace, the node throws an error "WhatsApp number cannot be empty".
- Invalid WhatsApp Number Format: The WhatsApp number must be between 10 and 15 digits after removing spaces, plus signs, dashes, and parentheses. Otherwise, an error "WhatsApp number must be 10-15 digits" is thrown.
- API Errors: If the WbizTool API returns a status other than 1, the node throws an error with the message from the API prefixed by "WbizTool API Error:".
- Network or Credential Issues: Failures to authenticate or reach the API will result in errors; ensure the API key credential is valid and network connectivity is available.
- To handle errors gracefully, enable the node's "Continue On Fail" option to process all items even if some fail.
Links and References
- WbizTool API Documentation (hypothetical link)
- WhatsApp Business API Overview
- n8n Documentation on Creating Custom Nodes