Health Checks

Wappi includes a built-in health check endpoint to monitor the status and health of your API. This endpoint is essential for monitoring, to ensure your API is running correctly.

Built-in Health Check Endpoints

Wappi automatically provides the health check endpoint that you can use without any additional configuration:

To do a health check, simply hit the URL:

All http methods will return a 200 response.

1GET /healthcheck

Response Object:

1{
2  "complete": true,
3  "statusCode": 200,
4  "message": "Healthy",
5  "success": true
6}

Try it locally

After running wappi run > then go to the url:

1npx wappi run

Go to: http://localhost:3030/healthcheck
{DOMAIN_URL}/healthcheck