Skip to content
Honeybadger Docs

Webhook

Team Business Enterprise
View Markdown

Honeybadger sends webhooks when certain events occur in your Honeybadger projects. Each one is a JSON body describing the event. See Webhook payloads for each event’s payload.

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

Section titled “Setup”

1. Select the Webhook integration

Section titled “1. Select the Webhook integration”

webhook integration webhook form

2. Set the URL for your webhook

Section titled “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 with a JSON body. See Delivery for what each request carries and how your service should respond.

3. Set a bearer token (optional)

Section titled “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 any request without an Authorization header before it reaches your code. If yours does, enter a token it accepts 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. Choose a payload version

Section titled “4. Choose a payload version”

The Payload version field sets the shape of the JSON body:

  • v2, the default. See the v2 payloads.
  • v3, in preview: its fields can change before general availability. See the v3 payloads.

A v3 body names its version in its own payload_version field; a v2 body has no such field.

5. Save

Section titled “5. Save”

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

Delivery

Section titled “Delivery”

For each event the integration is subscribed to, Honeybadger sends a POST with a JSON body to your URL. Every request carries a Honeybadger-Token header with the project’s outbound token, so you can check it came from Honeybadger, and Authorization: Bearer <token> when you’ve set a bearer token.

How your service responds decides what happens next:

  • Any 2xx response counts as delivered.
  • A 5xx response is retried.
  • Any other response, a timeout or a refused connection turns the integration off, and Honeybadger emails the account about it.