Webhook

Team Business Enterprise

Honeybadger sends webhooks when certain events occur in your Honeybadger projects. Each event type has a specific payload structure with relevant data about the event.

Users with administrative privileges can find this integration below the list of personal alert integrations on the Alerts & Integrations tab of the Project Settings page.

Setup

1. Select the Webhook integration

webhook integration webhook form

2. Set the URL for your webhook

We’ll post notifications to this URL. Make sure to include the protocol: e.g., https://mysite.com/hook.

Make sure you have a service running that can accept POST requests, and hopefully do something interesting with JSON payloads like this one:

{
  "event":"occurred",
  "message":"[Crywolf/test] RuntimeError - oops",
  "fault":{
    "id":3151009,
    "project_id":1717,
    "klass":"RuntimeError",
    "component":null,
    "action":null,
    "environment":"development",
    "resolved":true,
    "ignored":false,
    "created_at":"2014-01-08T18:55:48Z",
    "comments_count":1,
    "message":"oops",
    "notices_count":9,
    "last_notice_at":"2014-01-08T19:02:21Z"
  }
}

See Event Payloads for all available events and their structure.

3. Set a bearer token (optional)

Every webhook we send already includes a Honeybadger-Token header you can use to verify that the request came from us.

Some services reject a request outright unless it arrives with an Authorization header, before your own code ever sees it. If yours is one of them, put the key in the Bearer token field and we’ll send it with every request:

Authorization: Bearer your-token

Leave the field blank if you don’t need it. The token is encrypted at rest, and it’s masked when you come back to the form later.

4. Save

That’s it! Hit save and you’re good to go.

Payload structure

Each event payload is sent as a JSON object with the following properties:

event - The type of event (e.g., occurred, resolved, deployed)
message - A human-readable description of the event
Additional event-specific data (varies by event type)

Event payloads

The following events are supported by the Webhook integration:

Webhook

Setup

1. Select the Webhook integration

2. Set the URL for your webhook

3. Set a bearer token (optional)

4. Save

Payload structure

Event payloads

`assigned`

`cert_will_expire`

`check_in_missing`

`check_in_reporting`

`commented`

`deployed`

`down`

`occurred`

`rate_exceeded`

`resolved`

`unresolved`

`up`

`volume_spike`