Skip to content

commented

View Markdown

A comment was added to a fault, or to a bulk action’s faults.

Fields

42

The table lists every field of the body. You can validate a delivery against this event’s JSON Schema.

FieldTypeDescription
event required"commented"
message requiredstringA one-line summary of the event, as notifications show it.
actorobjectThe person who caused the event. Absent when Honeybadger, or an API token with no user, did.
actor.id requiredinteger
actor.email requiredstring
actor.name requiredstring | null
faultobjectThe fault. Absent for a bulk action, which sends fault_ids instead.
fault.id requiredinteger
fault.project_id requiredinteger
fault.klassstring | nullError class name.
fault.message requiredstring | nullThe error message, without the class name.
fault.componentstring | null
fault.actionstring | null
fault.environmentstring | null
fault.resolvedboolean
fault.ignoredboolean
fault.created_at requireddate-time
fault.project_namestring | null
fault.comments_countinteger
fault.notices_countinteger
fault.last_notice_atdate-time | null
fault.tagsarray | null
fault.assigneestring | nullThe assignee's email address.
fault.urluri
fault.deployobject | nullThe latest deploy to the fault's environment.
fault.deploy.environment requiredstring
fault.deploy.revision requiredstring | null
fault.deploy.repository requiredstring | null
fault.deploy.local_username requiredstring | null
fault.deploy.created_at requireddate-time
fault.deploy.changelog requiredarray | nullCommits in the deploy, as the deploy notification sent them.
fault.deploy.url requireduri
fault_idsarray<string>The faults a bulk action changed. Sent in place of fault.
comment requiredobjectThe comment that was added.
comment.id requiredinteger
comment.fault_id requiredinteger
comment.event requiredstring | null
comment.source requiredstring
comment.created_at requireddate-time
comment.email requiredstring | nullThe commenter's email, for a comment from someone without an account.
comment.author requiredstring | nullThe commenter's name.
comment.body requiredstring | null

Example

{
"event": "commented",
"message": "[Billing API/production] Jane Doe commented on NoMethodError: Looking into this now.",
"actor": {
"id": 132624,
"email": "jane@example.com",
"name": "Jane Doe"
},
"fault": {
"project_id": 85736,
"klass": "NoMethodError",
"component": "InvoicesController",
"action": "show",
"environment": "production",
"resolved": false,
"ignored": false,
"created_at": "2026-10-18T12:36:26.482113Z",
"project_name": "Billing API",
"comments_count": 1,
"message": "undefined method 'total' for nil",
"notices_count": 1,
"last_notice_at": "2026-10-21T12:36:26.309680Z",
"tags": [
"billing"
],
"id": 26225,
"assignee": "jane@example.com",
"url": "https://app.honeybadger.io/projects/85736/faults/26225",
"deploy": {
"environment": "production",
"revision": "850510ab072102729e6967cf89f28b740c61311b",
"repository": "https://github.com/acme/billing",
"local_username": "deploy-bot",
"created_at": "2026-10-21T12:16:26.482113Z",
"changelog": [],
"url": "https://github.com/acme/billing/commit/850510ab072102729e6967cf89f28b740c61311b"
}
},
"comment": {
"id": 2236,
"fault_id": 26225,
"event": null,
"source": "web",
"created_at": "2026-10-21T12:36:26.357793Z",
"email": null,
"author": "Jane Doe",
"body": "Looking into this now."
}
}