Overview

This node interacts with the WARest WhatsApp REST API to perform various server-related operations. Specifically, the 'Health Check' operation checks the health status of the server by calling the '/api/v1/server/healthz' endpoint. This is useful for monitoring the server's availability and responsiveness, ensuring that the WhatsApp REST API server is running correctly. Practical use cases include automated monitoring workflows that alert users if the server becomes unresponsive or unhealthy.

Use Case Examples

1. A workflow that periodically checks the server health and sends a notification if the server is down.
2. A diagnostic tool within a larger WhatsApp automation system to verify server status before sending messages.

Output

JSON

• json - The JSON response from the server health check endpoint, indicating the server's health status

Dependencies

• Requires an API key credential for the WARest WhatsApp REST API and the base URL of the API server.

Troubleshooting

• If the node throws an error stating the operation is not implemented, ensure the resource is set to 'Server' and the operation to 'Health Check'.
• Network errors may occur if the base URL is incorrect or the server is unreachable; verify the API base URL and network connectivity.
• Authentication errors indicate issues with the provided API key credential; check that the API key is valid and has the necessary permissions.

Links

• WARest API Server Health Check - Official documentation for the server health check endpoint of the WARest WhatsApp REST API.