Skip to content
Honeybadger Docs

Reporting check-ins

To report a check-in, simply send a GET request to the endpoint URL you received when creating the check-in:

Terminal window
curl https://api.honeybadger.io/v1/check_in/XyZZy

You can also send an email (no subject or body required) to XyZZy@report.hbchk.in, where XyZZy is the same (case-sensitive) ID from the endpoint URL.

If you specify a slug for a check-in, you can use that slug and the project’s API key in the URL rather than the ID:

Terminal window
curl https://api.honeybadger.io/v1/check_in/PROJECT_API_KEY/my_identifier

Check-in payloads

Section titled “Check-in payloads”

Business-tier accounts can send additional check-in details via POST. The payload is optional and must be under 20KB.

Terminal window
curl -X POST https://api.honeybadger.io/v1/check_in/XyZZy \
  -H "Content-Type: application/json" \
  -d '{
    "check_in": {
      "status": "success",
      "duration": 1234,
      "stdout": "backup completed",
      "stderr": "",
      "exit_code": 0
    }
  }'

The check_in object supports:

  • status (string): success or error
  • duration (integer): milliseconds
  • stdout (string): captured standard output
  • stderr (string): captured standard error
  • exit_code (integer): process exit code

The data sent with the check_in object will be sent to Insights as part of the check-in event. You can find more information on using check-ins here.