Skip to content

An uptime site went down or came back up.

Fields

38

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

FieldTypeDescription
event required"up"
message requiredstringA one-line summary of the event, as notifications show it.
payload_version requiredstringThe integration's payload version. Allowed value: v3.
actorobjectThe person who caused the event. Absent when Honeybadger did.
actor.id requiredstring | nullThe user's ID, or null when the person has no Honeybadger account.
actor.name requiredstring | null
actor.email requiredstring | null
credentialobjectThe API token or OAuth grant the event was caused through. Absent when the event wasn't caused through the API.
credential.type requiredstringApiToken for an API token, OauthAccessToken for an OAuth grant.
credential.id requiredstring
credential.name requiredstring | nullThe token's name. For an OAuth grant, the name the user gave the connection, or the application's name if none.
project requiredobjectThe project the event belongs to.
project.id requiredstring
project.name requiredstring
project.language requiredstring | null
project.created_at requireddate-time
project.links requiredobjectLinks into the Honeybadger web UI.
project.links.web requireduriThe resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have links. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
links requiredobjectThe page to open for this event.
links.web requireduriThe resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have links. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
site requiredobjectThe uptime site the event is about.
site.id requireduuid
site.project_id requiredstring
site.name requiredstring
site.url requiredstringThe checked URL, with any credentials in it removed.
site.state requiredstringAllowed values: pending, up, down.
site.frequency requiredintegerMinutes between checks. A value below the plan's floor is refused. Allowed values: 1, 2, 5, 15.
site.last_checked_at requireddate-time | null
site.created_at requireddate-time
site.links requiredobjectLinks into the Honeybadger web UI.
site.links.web requireduriThe resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have links. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
outage requiredobjectThe site's latest outage. Every field is null when the site has none on record. Outages have no page of their own; the site's links has its page.
outage.id requireduuid | null
outage.site_id requireduuid | null
outage.down_at requireddate-time | null
outage.up_at requireddate-time | nullNull while the site is still down.
outage.duration_seconds requiredinteger | nullNull until the site is back up.
outage.created_at requireddate-time | null

Example

{
"event": "up",
"message": "[Billing API] Checkout is back up after 7m 1s.",
"project": {
"id": "H99upHsM",
"name": "Billing API",
"language": "ruby",
"created_at": "2026-10-21T12:36:26Z",
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/faults"
}
},
"site": {
"id": "8121ab91-87fd-4e92-ae23-a7b5bf915a2f",
"project_id": "H99upHsM",
"name": "Checkout",
"url": "https://billing.example.com/health",
"state": "up",
"frequency": 5,
"last_checked_at": "2026-10-21T12:36:26Z",
"created_at": "2026-09-21T12:36:26Z",
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/sites/8121ab91-87fd-4e92-ae23-a7b5bf915a2f"
}
},
"outage": {
"id": "c2dde716-bcc4-43dc-8212-9fa287505c94",
"site_id": "8121ab91-87fd-4e92-ae23-a7b5bf915a2f",
"down_at": "2026-10-21T12:29:26Z",
"up_at": "2026-10-21T12:36:26Z",
"duration_seconds": 420,
"created_at": "2026-10-21T12:36:26Z"
},
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/sites/8121ab91-87fd-4e92-ae23-a7b5bf915a2f"
},
"payload_version": "v3"
}