Browse the docs

Heartbeats

The endpoint your cron jobs ping so a heartbeat monitor knows they ran.

Create a monitor with type: "heartbeat" and you get a heartbeat_url. Anything that can make an HTTP request can ping it; there is no body and no authentication beyond the token in the URL. See the heartbeats guide.

Send a pulse

POST/heartbeats/:token

Records that the job ran. GET works too, for tools that can only fetch a URL. Rate limited to 120 pulses per minute per token; the monitor only needs one per interval.

Path parameters

tokenstringrequired
The token from the monitor's heartbeat_url, starting with hb_.
An unknown token answers 404. If a job starts getting 404s, the monitor was deleted or recreated with a new token.
Request
curl -X POST "https://api.statusbee.co/heartbeats/hb_9f2c…"
Response
{
  "statusCode": 200,
  "error": false,
  "message": null,
  "data": {
    "ok": true
  }
}