Skip to content

deployed

View Markdown

A deploy was recorded.

Fields

28

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

FieldTypeDescription
event required"deployed"
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.
deploy requiredobjectThe deploy the event is about.
deploy.id requiredstring
deploy.project_id requiredstring
deploy.environment requiredstring
deploy.revision requiredstring | null
deploy.repository requiredstring | nullThe repository URL, with any credentials in it removed.
deploy.local_username requiredstring | null
deploy.created_at requireddate-time

Example

{
"event": "deployed",
"message": "[Billing API/production] deploy-bot deployed Billing API to production",
"project": {
"id": "H99upHsM",
"name": "Billing API",
"language": "ruby",
"created_at": "2026-10-21T12:36:26Z",
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/faults"
}
},
"deploy": {
"id": "npElcwM0Gdh1",
"project_id": "H99upHsM",
"environment": "production",
"revision": "850510ab072102729e6967cf89f28b740c61311b",
"repository": "https://github.com/acme/billing",
"local_username": "deploy-bot",
"created_at": "2026-10-21T12:16:26Z"
},
"links": {
"web": "https://app.honeybadger.io/projects/H99upHsM/deploys?environment=production"
},
"payload_version": "v3"
}