Skip to content

commented

View Markdown

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

Fields

53

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.
payload_version requiredstringThe integration's payload version. Allowed value: v3.
actorobjectThe person who caused the event. Absent when Honeybadger did.
actor.id requiredstring | nullThe user's ID, or null when the person has no Honeybadger account.
actor.name requiredstring | null
actor.email requiredstring | null
credentialobjectThe API token or OAuth grant the event was caused through. Absent when the event wasn't caused through the API.
credential.type requiredstringApiToken for an API token, OauthAccessToken for an OAuth grant.
credential.id requiredstring
credential.name requiredstring | nullThe token's name. For an OAuth grant, the name the user gave the connection, or the application's name if none.
project requiredobjectThe project the event belongs to.
project.id requiredstring
project.name requiredstring
project.language requiredstring | null
project.created_at requireddate-time
project.links requiredobjectLinks into the Honeybadger web UI.
project.links.web requireduriThe 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 requiredobjectThe page to open for this event.
links.web requireduriThe 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.
faultobjectThe fault. Absent for a bulk action, which sends fault_ids instead.
fault.id requiredstring
fault.project_id requiredstring
fault.klass requiredstring | nullError class name.
fault.message requiredstring | null
fault.component requiredstring | null
fault.action requiredstring | null
fault.environment requiredstring | null
fault.resolved requiredboolean
fault.ignored requiredboolean
fault.tags requiredarray | null
fault.assignee requiredobject | null
fault.assignee.id requiredstring | nullThe user's ID, or null when the person has no Honeybadger account.
fault.assignee.name requiredstring | null
fault.assignee.email requiredstring | null
fault.notices_count requiredinteger
fault.created_at requireddate-time
fault.last_notice_at requireddate-time | null
fault.links requiredobjectLinks into the Honeybadger web UI.
fault.links.web requireduriThe 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_idsarray<string>The faults a bulk action changed. Sent in place of fault.
comment requiredobjectThe comment that was added.
comment.id requiredstring
comment.fault_id requiredstring
comment.body requiredstring | null
comment.source requiredstringWhere the comment was made, such as web or email.
comment.created_at requireddate-time
comment.author requiredobject | null
comment.author.id requiredstring | nullThe user's ID, or null when the person has no Honeybadger account.
comment.author.name requiredstring | null
comment.author.email requiredstring | null
comment.links requiredobjectLinks into the Honeybadger web UI.
comment.links.web requireduriThe 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

{
"event": "commented",
"message": "[Billing API/production] Jane Doe commented on NoMethodError: Looking into this now.",
"actor": {
"id": "DDiJ4d5",
"name": "Jane Doe",
"email": "jane@example.com"
},
"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": {
"id": "DDiJ4d5",
"name": "Jane Doe",
"email": "jane@example.com"
},
"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"
}
},
"comment": {
"id": "Mo6nm8kUsjuh",
"fault_id": "26225",
"body": "Looking into this now.",
"source": "web",
"created_at": "2026-10-21T12:36:26Z",
"author": {
"id": "DDiJ4d5",
"name": "Jane Doe",
"email": "jane@example.com"
},
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/faults/26225#comment_2236"
}
},
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/faults/26225#comment_2236"
},
"payload_version": "v3"
}