Sign in

API reference

Heartbeats

Endpoint GET, POST or HEAD /hb/:token

A heartbeat monitor gives you a URL with a secret token. Call it when the job finishes; the monitor goes down when no ping arrives within the interval plus the grace period.

1Request

Any of GET, POST or HEAD to https://in.blipit.io/hb/<token>. No key, no body. Only the token's hash is stored, the URL is shown once when created and can be replaced from the Uptime page.

sh
0 2 * * * /usr/local/bin/backup.sh && curl -fsS https://in.blipit.io/hb/<token>

2Responses

200 {ok: true}. 404 {error: 'no heartbeat with that URL'} for an unknown token. 429 after 60 unknown URLs from one address in a minute; a URL that has pinged before keeps working during the block.

Good to know

  • Put the ping after && so a failed job does not ping.
  • Heartbeats are evaluated once a minute and are not region-bound.

Stuck? Email support@blipit.io. Keys and the exact DSN for each project are under API keys in app.blipit.io.