Deployments API

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

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

To do this, make a POST request to with the following parameters:

Parameter Description
api_key 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.
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:

curl --data "deploy[environment]=production&deploy[local_username]=Mary&deploy[revision]=12345&deploy[repository]=" ""

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

curl \
-H 'X-API-Key: asdf' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "deploy": {
    "environment": "production",
    "local_username": "sam",
    "revision": "7cd4bac1bd7e2ddf858d10ee86e362c8d8e2f912",
    "repository": ""

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