Overview
This node checks the connection status of a WhatsApp client using the WbizTool API. It is useful for monitoring whether a specific WhatsApp client is currently connected or disconnected. Typical use cases include automated health checks, alerting systems, or dashboards that track WhatsApp client availability.
The node supports two methods to check the status:
- General Status: Checks the overall client status by sending the client ID as a parameter.
- Status by ID: Checks the status by including the client ID directly in the URL path.
For example, you can input a WhatsApp Client ID and select the method to verify if that client is connected, then use the output to trigger further workflows based on the connection state.
Properties
| Name | Meaning |
|---|---|
| WhatsApp Client ID | The numeric ID of the WhatsApp client whose status you want to check. Must be a positive number. |
| Check Method | The method used to check the WhatsApp client status. Options: - General Status: sends client ID as a parameter. - Status by ID: includes client ID in the URL path. |
Output
The node outputs an array with one item per input. Each item contains a json object with the following structure:
success: Boolean indicating if the API call was successful.whatsappClientId: The client ID checked.status: Numeric status code returned by the API (1 indicates success).message: Status message from the API.isConnected: Boolean indicating if the client is connected (trueif connected).connectionStatus: String"connected"or"disconnected"based on connection state.response: Full raw response from the API.input: Object echoing back the input parameters (whatsappClientId,checkMethod).statusCheck: Detailed status info including:whatsappClientIdconnectionStatusisConnectedstatusMessage(same asmessage)checkedAt: ISO timestamp when the check was performed.checkMethod
If the node encounters an error and "Continue On Fail" is enabled, it outputs an object with success: false and an error message describing the failure.
The node does not output binary data.
Dependencies
- Requires credentials for the WbizTool API, specifically an API key and client ID.
- The node makes HTTP POST requests to the WbizTool API endpoints to retrieve WhatsApp client status.
- Proper configuration of the WbizTool API credential in n8n is necessary.
Troubleshooting
- Invalid WhatsApp Client ID: If the client ID is missing or not a positive number, the node throws an error. Ensure the client ID is correctly provided and valid.
- API Errors: If the WbizTool API returns a status other than 1, the node throws an error with the API's message. Verify your API credentials and client ID.
- Network Issues: Connectivity problems may cause request failures. Check network access and API endpoint availability.
- Credential Misconfiguration: Missing or incorrect API credentials will prevent successful API calls.
- Enable "Continue On Fail" to handle errors gracefully and continue processing multiple items.
Links and References
- WbizTool API Documentation (Assumed link, replace with actual if available)
- n8n Documentation on Credentials
- n8n Node Development Guide