Reporting Deployments

Ruby users: make sure you check out our section on Ruby deployment tracking before you re-invent the wheel.

Deploying with GitHub Actions

If your CI/CD pipeline is hosted with GitHub Actions, you can use the Honeybadger Deploy Action to notify our API about deployments.

Sending deployment notifications manually

If you need to manually notify Honeybadger of a deploy, you can use our API directly.

To do this, make a POST request to https://api.honeybadger.io/v1/deploys with the following parameters:

Parameter	Required	Description
api_key	Required	Your project's API key
deploy[environment]	Optional	The environment name. Example: `production`
deploy[revision]	Optional	The VCS revision being deployed. Could be a git hash, or a tag name. Example: `7cd4bac1bd7e2ddf858d10ee86e362c8d8e2f912`
deploy[repository]	Optional	The base URL of the VCS repository. It should be HTTPS-style. Example: `https://github.com/honeybadger-io/honeybadger-ruby`
deploy[local_username]	Optional	The name of the user who is deploying. Example: `Jane`

Here's an example curl command to do a deploy notification:

bash

curl --data "deploy[environment]=production&deploy[local_username]=Mary&deploy[revision]=12345&deploy[repository]=https://github.com/user/repo.git&api_key=asdf" "https://api.honeybadger.io/v1/deploys"

You can also send a JSON payload when specifying the content type as application/json:

bash

  

curl https://api.honeybadger.io/v1/deploys \
-H 'X-API-Key: asdf' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "deploy": {
    "environment": "production",
    "local_username": "sam",
    "revision": "7cd4bac1bd7e2ddf858d10ee86e362c8d8e2f912",
    "repository": "https://github.com/someuser/somerepo"
  }
}'

If everything goes well, you'll get a response saying {"status":"OK"}