---
title: rate_exceeded
description: The v3 webhook payload for the rate_exceeded event, in preview. An error occurred, or a fault passed its notification rate threshold.
url: https://docs.honeybadger.io/guides/integrations/payloads/v3/rate_exceeded/
---

The v3 payload is in preview

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

An error occurred, or a fault passed its notification rate threshold.

## 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/rate_exceeded.schema.json).

| Field | Type | Description |
| - | - | - |
| `event` required | "rate\_exceeded" | |
| `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. |
| `fault` required | object | The fault (a unique error) the event is about. |
| `fault.id` required | string | |
| `fault.project_id` required | string | |
| `fault.klass` required | string \| null | Error class name. |
| `fault.message` required | string \| null | |
| `fault.component` required | string \| null | |
| `fault.action` required | string \| null | |
| `fault.environment` required | string \| null | |
| `fault.resolved` required | boolean | |
| `fault.ignored` required | boolean | |
| `fault.tags` required | array \| null | |
| `fault.assignee` required | object \| null | |
| `fault.assignee.id` required | string \| null | The user's ID, or null when the person has no Honeybadger account. |
| `fault.assignee.name` required | string \| null | |
| `fault.assignee.email` required | string \| null | |
| `fault.notices_count` required | integer | |
| `fault.created_at` required | date-time | |
| `fault.last_notice_at` required | date-time \| null | |
| `fault.links` required | object | Links into the Honeybadger web UI. |
| `fault.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. |
| `notice` required | object | The occurrence that triggered the event. |
| `notice.id` required | uuid | |
| `notice.fault_id` required | string \| null | |
| `notice.project_id` required | string \| null | |
| `notice.environment` required | string \| null | |
| `notice.message` required | string \| null | |
| `notice.created_at` required | date-time | |
| `notice.links` | object | Links into the Honeybadger web UI. |
| `notice.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. |

## Example

```json
{
  "event": "rate_exceeded",
  "message": "[Billing API/production] NoMethodError has occurred 5 time(s) in the past minute",
  "project": {
    "id": "H99upHsM",
    "name": "Billing API",
    "language": "ruby",
    "created_at": "2026-10-21T12:36:26Z",
    "links": {
      "web": "https://app.honeybadger.io/projects/H99upHsM/faults"
    }
  },
  "fault": {
    "id": "26225",
    "project_id": "H99upHsM",
    "klass": "NoMethodError",
    "message": "undefined method 'total' for nil",
    "component": "InvoicesController",
    "action": "show",
    "environment": "production",
    "resolved": false,
    "ignored": false,
    "tags": [
      "billing"
    ],
    "assignee": null,
    "notices_count": 1,
    "created_at": "2026-10-18T12:36:26Z",
    "last_notice_at": "2026-10-21T12:36:26Z",
    "links": {
      "web": "https://app.honeybadger.io/projects/H99upHsM/faults/26225"
    }
  },
  "notice": {
    "id": "65baebe0-d5cf-45d1-8604-c3a78619def7",
    "fault_id": "26225",
    "project_id": "H99upHsM",
    "environment": "production",
    "message": "NoMethodError: undefined method 'total' for nil",
    "created_at": "2026-10-21T12:34:26Z",
    "links": {
      "web": "https://app.honeybadger.io/projects/H99upHsM/faults/26225/01M5F79AHJ6GVQCB5TZ2R0QMKZ"
    }
  },
  "links": {
    "web": "https://app.honeybadger.io/projects/H99upHsM/faults/26225"
  },
  "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/)