---
title: volume_spike
description: The v3 webhook payload for the volume_spike event, in preview. A project's error volume rose well above its usual level.
url: https://docs.honeybadger.io/guides/integrations/payloads/v3/volume_spike/
---

The v3 payload is in preview

Its fields can change before general availability. v2, the default, is unchanged.

A project’s error volume rose well above its usual level.

## Fields

The table lists every field of the body. You can validate a delivery against this event’s [JSON Schema](https://docs.honeybadger.io/guides/integrations/payloads/v3/volume_spike.schema.json).

| Field | Type | Description |
| - | - | - |
| `event` required | "volume\_spike" | |
| `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. |
| `volume_spike` required | object | The error volume that triggered the spike alert. |
| `volume_spike.observed` required | integer | Errors in the window just checked. |
| `volume_spike.baseline_median` required | integer | The median for a window of the same length over the baseline. |
| `volume_spike.factor` required | number \| null | `observed` over `baseline_median`, to one decimal. |
| `volume_spike.z_score` required | number \| null | |
| `volume_spike.window_minutes` required | integer | |

## Example

```json
{
  "event": "volume_spike",
  "message": "[Billing API] Errors are 3.2× your normal rate (412 in the last hour vs ~128/hr typical)",
  "project": {
    "id": "H99upHsM",
    "name": "Billing API",
    "language": "ruby",
    "created_at": "2026-10-21T12:36:26Z",
    "links": {
      "web": "https://app.honeybadger.io/projects/H99upHsM/faults"
    }
  },
  "volume_spike": {
    "observed": 412,
    "baseline_median": 128,
    "factor": 3.2,
    "z_score": 9.1,
    "window_minutes": 60
  },
  "links": {
    "web": "https://app.honeybadger.io/projects/H99upHsM/faults"
  },
  "payload_version": "v3"
}
```

---

## Try Honeybadger for FREE

Intelligent logging, error tracking, and Just Enough APM™ in one dev-friendly platform. Find and fix problems before users notice.

[Start free trial](https://app.honeybadger.io/users/sign_up)

[See plans and pricing](https://www.honeybadger.io/plans/)