A deploy was recorded.
Fields
28The table lists every field of the body. You can validate a delivery against this event’s JSON Schema.
| Field | Type | Description |
|---|---|---|
event required | "deployed" | |
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. |
deploy required | object | The deploy the event is about. |
deploy.id required | string | |
deploy.project_id required | string | |
deploy.environment required | string | |
deploy.revision required | string | null | |
deploy.repository required | string | null | The repository URL, with any credentials in it removed. |
deploy.local_username required | string | null | |
deploy.created_at required | date-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"}