Goals
- Check service availability after deployments.
- Provide an HTTP endpoint for external monitoring.
- Confirm routing and TLS are working end-to-end.
Endpoint
| Method | Path | Description |
|---|---|---|
GET | /health | Returns a lightweight text response. |
Headers: none required. Response is plain text.
Example
Request:
curl -s https://wa.onebrick.io/health
Response (sample):
ok
- Returns HTTP 200 with body
okwhen healthy. - Use header
X-Request-IDif you need traceability in logs.
Usage Notes
- Recommended for probes (e.g., uptime monitors) at a conservative interval.
- Does not check downstream dependencies (e.g., WhatsApp connectivity); it only validates the API process is running.
- For deeper health (device connectivity, webhook delivery), combine with functional tests via devices/messages endpoints.