check_in

A heartbeat or report from a scheduled job or cron monitor. The state field shows whether the run succeeded, failed, or reported its status.

Category Check-ins Fields 10 honeybadger

Fields

10

Field	Type	Description
event_type	string	Allowed value: check_in.
check_in_id	string	Stable identifier for the monitored check-in / job.
state	string	Reported state of the run. reporting means the job sent a heartbeat for the scheduled window. missing means the window expired without a heartbeat. paused means the monitor is paused. Allowed values: reporting, missing, paused.
payload	object	Optional report sent with advanced check-ins. The fields listed below are common, but the job can send other fields too.
payload.status	string	Job outcome label. "success" appears as a check icon in the UI. Any other value is treated as a failure label.
payload.duration	number	How long the job took, in milliseconds.
payload.exit_code	integer	Process exit code reported by the job. 0 conventionally means success.
payload.stdout	string	Captured stdout from the job run.
payload.stderr	string	Captured stderr from the job run.
payload.*	any	Additional caller-defined keys.

Example

{
  "event_type": "check_in",
  "check_in_id": "wNgxJv",
  "state": "reporting",
  "payload": {
    "status": "success",
    "duration": 4523,
    "exit_code": 0,
    "stdout": "Processed 1240 records",
    "stderr": ""
  }
}