api_key. It is sent as Authorization: Bearer <token>. Three token kinds work: a user API token (hbu_), an account API token (hba_) for automation, or an OAuth access token. A v2 personal auth token does not work with v3.
Things to know before you call:
- Pick the right region. Honeybadger runs a US app and an EU app, and an account lives in one of them. A US token is answered
401by the EU host and the reverse. The plugin defaults tous; set the account’sregionfield toeuwhen the account is oneu-app.honeybadger.io(or passregion: 'eu'to the plugin in code, which applies to every tenant). The token prefix is the same in both, so it cannot be detected. - Project-scoped calls need
project_id. Everything exceptprojects.list,projects.create,occurrences.list,notices.get,account.*andtoken.gettakes one. A project ID is a short opaque string such asXk9mZp, not a number, and v3 IDs differ from the v2 ones. Get them fromprojects.list. - Errors branch on a code, not a message. A failure body is
{ error: { code, message, details } }. The plugin keepsstatusandcodeon the thrown error and drops the body, because a validation failure echoes the submitted values.detailsbecomes text in the message, such as which field failed or which scope a 403 needed. - Time filters are Unix seconds.
created_after,occurred_afterandoccurred_beforetake numbers, as the API documents. An ISO string is refused before the request is sent. - Bulk fault changes need a bound.
faults.resolve,unresolve,ignoreandunignoretake eitherfault_idsorall: true. A request with neither is refused here, because the API answers422for it.dry_run: truereports what would change without changing it. - Pagination differs by collection. Numbered lists (
projects,faults,environments,checkIns,sites,streams) takepageandper_page, capped at 100.notices,commentsanddeploystakelimitand abeforeoraftercursor, which you read fromlinks.olderandlinks.newer. The rest window on time instead of a cursor:checkIns.eventstakeslimitandcreated_before,sites.checksandsites.outagestakelimit,created_afterandcreated_before, andfaults.occurrencestakesoccurred_afterandoccurred_before. - Rate limits are 360 requests an hour per token. A
429carriesRetry-Afterand is retried three times.concurrent_requestandstreams_provisioningare also429s, and both mean try again. The plugin readsRetry-Afteronly, neverX-RateLimit-Reset, because the budget resets on the hour, and waiting for that reset would hold the call for most of an hour. - A merged fault redirects. After a merge finishes, a read of the old ID answers
301to the target and the old ID eventually404s. A write against it answers409 fault_mergedwith the target indetails. - No inbound webhooks. Honeybadger sends no deliveries to an arbitrary URL, so this plugin registers no webhook route. Its notification integrations are per-project and configured in the web UI or through the integrations API, which this plugin does not wrap.
- Deletes answer 204. They return
{ deleted: true }plus the IDs that were removed, because the provider sends no body to report.
- 62 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Honeybadger API key before the first call: More: API Key
pnpm corsair setup --plugin=honeybadger --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
Read the unresolved faults in a projectWhat’s next
API reference
Every
honeybadger.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.