An uptime site went down or came back up.
Fields
38The table lists every field of the body. You can validate a delivery against this event’s JSON Schema.
| Field | Type | Description |
|---|---|---|
event required | "down" | |
message required | string | A one-line summary of the event, as notifications show it. |
payload_version required | string | The integration's payload version. Allowed value: v3. |
actor | object | The person who caused the event. Absent when Honeybadger did. |
actor.id required | string | null | The user's ID, or null when the person has no Honeybadger account. |
actor.name required | string | null | |
actor.email required | string | null | |
credential | object | The API token or OAuth grant the event was caused through. Absent when the event wasn't caused through the API. |
credential.type required | string | ApiToken for an API token, OauthAccessToken for an OAuth grant. |
credential.id required | string | |
credential.name required | string | null | The token's name. For an OAuth grant, the name the user gave the connection, or the application's name if none. |
project required | object | The project the event belongs to. |
project.id required | string | |
project.name required | string | |
project.language required | string | null | |
project.created_at required | date-time | |
project.links required | object | Links into the Honeybadger web UI. |
project.links.web required | uri | The 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 required | object | The page to open for this event. |
links.web required | uri | The 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 required | object | The uptime site the event is about. |
site.id required | uuid | |
site.project_id required | string | |
site.name required | string | |
site.url required | string | The checked URL, with any credentials in it removed. |
site.state required | string | Allowed values: pending, up, down. |
site.frequency required | integer | Minutes between checks. A value below the plan's floor is refused. Allowed values: 1, 2, 5, 15. |
site.last_checked_at required | date-time | null | |
site.created_at required | date-time | |
site.links required | object | Links into the Honeybadger web UI. |
site.links.web required | uri | The 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 required | object | The 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 required | uuid | null | |
outage.site_id required | uuid | null | |
outage.down_at required | date-time | null | |
outage.up_at required | date-time | null | Null while the site is still down. |
outage.duration_seconds required | integer | null | Null until the site is back up. |
outage.created_at required | date-time | null |
Example
{ "event": "down", "message": "[Billing API] Checkout is down.", "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": "down", "frequency": 5, "last_checked_at": "2026-10-21T12:35: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": null, "duration_seconds": null, "created_at": "2026-10-21T12:36:26Z" }, "links": { "web": "https://app.honeybadger.io/projects/H99upHsM/sites/8121ab91-87fd-4e92-ae23-a7b5bf915a2f" }, "payload_version": "v3"}