Skip to content

check_in_reporting

View Markdown

A check-in missed its schedule, or started reporting again.

Fields

59

The table lists every field of the body. You can validate a delivery against this event’s JSON Schema.

FieldTypeDescription
event required"check_in_reporting"
message requiredstringA one-line summary of the event, as notifications show it.
actorobjectThe person who caused the event. Absent when Honeybadger, or an API token with no user, did.
actor.id requiredinteger
actor.email requiredstring
actor.name requiredstring | null
project requiredobjectThe project the event belongs to.
project.id requiredinteger
project.name requiredstring | null
project.created_at requireddate-time
project.disable_public_links requiredboolean | null
project.pivotal_project_id requiredstring | null
project.asana_workspace_id requiredstring | null
project.token requiredstringThe project's ingestion key, the one its notifiers report with.
project.github_project requiredstring | nullThe repository of the project's newest GitHub integration.
project.environments requiredarray<object>
project.environments[].id requiredinteger
project.environments[].project_id requiredinteger
project.environments[].name requiredstring
project.environments[].notifications requiredbooleanWhether errors in this environment send notifications.
project.environments[].created_at requireddate-time
project.environments[].updated_at requireddate-time
project.owner requiredobjectThe account that owns the project.
project.owner.id requiredinteger
project.owner.email requiredstring
project.owner.name requiredstring | null
project.last_notice_at requireddate-time | null
project.earliest_notice_at requireddate-timeThe oldest notice the plan's retention keeps.
project.unresolved_fault_count requiredinteger
project.fault_count requiredinteger
project.active requiredbooleanWhether the account is active.
project.users requiredarray<object>
project.users[].id requiredinteger
project.users[].email requiredstring
project.users[].name requiredstring | null
project.sites requiredarray<object>
project.sites[].id requireduuid
project.sites[].active requiredboolean
project.sites[].last_checked_at requireddate-time | null
project.sites[].name requiredstring
project.sites[].state requiredstring
project.sites[].url requiredstringThe checked URL, as entered.
project.team_id requiredinteger | null
project.urluriThe project's errors page. Sent on volume_spike only.
check_in requiredobjectThe check-in the event is about.
check_in.id requiredstring
check_in.name requiredstring | null
check_in.slug requiredstring | null
check_in.state requiredstringAllowed values: pending, reporting, missing, paused.
check_in.schedule_type requiredstringAllowed values: simple, cron.
check_in.reported_at requireddate-time | null
check_in.expected_at requireddate-time | null
check_in.missed_count requiredinteger
check_in.grace_period requiredstringHow late a report can be before the check-in is missing, as a duration such as 5 minutes. Empty when there's no grace period.
check_in.report_periodstringHow often the job reports, as a duration such as 1 day. Sent for simple check-ins.
check_in.cron_schedulestringSent for cron check-ins.
check_in.cron_timezonestringSent for cron check-ins.
check_in.url requiredstringThe URL the job reports to.
check_in.details_url requireduri

Example

{
"event": "check_in_reporting",
"message": "[Billing API] REPORTING: Nightly invoice run is reporting again",
"project": {
"id": 85736,
"name": "Billing API",
"created_at": "2026-10-21T12:36:26.076894Z",
"disable_public_links": false,
"pivotal_project_id": null,
"asana_workspace_id": null,
"token": "hbp_EXAMPLE00000000000000000000000",
"github_project": null,
"environments": [
{
"id": 2819,
"project_id": 85736,
"name": "production",
"notifications": true,
"created_at": "2026-10-21T12:36:26.470494Z",
"updated_at": "2026-10-21T12:36:26.470494Z"
}
],
"owner": {
"id": 92354,
"email": "user-1@example.com",
"name": "Acme"
},
"last_notice_at": null,
"earliest_notice_at": "2026-04-24T12:36:28.118724Z",
"unresolved_fault_count": 0,
"fault_count": 0,
"active": true,
"users": [
{
"id": 132624,
"email": "jane@example.com",
"name": "Jane Doe"
}
],
"sites": [
{
"id": "8121ab91-87fd-4e92-ae23-a7b5bf915a2f",
"active": true,
"last_checked_at": "2026-10-21T12:36:26.482113Z",
"name": "Checkout",
"state": "up",
"url": "https://billing.example.com/health"
}
],
"team_id": null
},
"check_in": {
"state": "reporting",
"schedule_type": "simple",
"reported_at": "2026-10-21T12:36:26.482113Z",
"expected_at": "2026-10-22T12:36:26.482113Z",
"missed_count": 0,
"grace_period": "",
"id": "b3IAob",
"name": "Nightly invoice run",
"slug": "nightly-invoice-run",
"url": "https://api.honeybadger.io/v1/check_in/b3IAob",
"details_url": "https://app.honeybadger.io/projects/85736/check_ins",
"report_period": "1 day"
}
}