Docs / MonitoringBrowse

Deploy markers

When a site breaks right after a release, the release is usually why. Report each deploy from your CI, and Heedery marks it on the response-time chart and names it on any incident that follows.

On this page
  1. What you get
  2. Create a deploy token
  3. Report a deploy
  4. GitHub Action

What you get

Plan/Pro and up

  • A line on the site’s response-time chart for each deploy, with how many were followed by an incident.
  • On an incident that starts within 30 minutes of a deploy: “Deployed v1.4.2 (3f9a2c1) 2 min before”.
  • The same note in the mobile app.

Create a deploy token

  1. 1.
    Go to Settings then Integrations and find Deploy tokens.
  2. 2.
    Name the token after where it runs, such as “GitHub Actions”, and press Create token.
  3. 3.
    Copy it now; it starts with hdd_ and is not shown again. Store it in your CI’s secrets as HEEDERY_DEPLOY_TOKEN.

A workspace can have 10 deploy tokens. Owners and admins create them. A pipeline that stores it as SDM_DEPLOY_TOKEN, the name older examples used, keeps working.

The Deploys section of Settings, Integrations, with the Deploy tokens panel
Settings → Integrations, the Deploys section. Report a deploy, below it, has ready-made steps for each CI.

Report a deploy

Send a POST to /api/deploys after each deploy. Under Report a deploy the app has copy-ready steps for GitHub Actions, GitLab CI, Vercel, Netlify and plain curl, with your own address filled in.

curl
curl -fsS -X POST "https://heedery.com/api/deploys" \
  -H "Authorization: Bearer $HEEDERY_DEPLOY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "v1.4.2",
    "commit": "3f9a2c1d7e",
    "environment": "production",
    "description": "Faster checkout",
    "sites": ["app.example.com"]
  }'
FieldMeaning
version
Required. A tag, release name or ref.
commit
The commit sha; shown as its first 7 characters.
environment
"production", "staging"…
description
A line about the change, up to 500 characters.
url
A link to the release, the pipeline run or the diff.
sites
Site ids or hosts ("app.example.com"). Leave it out for every site.
deployedAt
ISO time or Unix timestamp; defaults to when it arrives.

A token may report 30 deploys a minute. The CI examples only print a warning when a report fails, so monitoring never fails a deploy.

GitHub Action

Use doessoft/heedery-actions as a step after your deploy step, with the token in HEEDERY_DEPLOY_TOKEN. The GitHub Actions tab under Report a deploy has the full step.

Still stuck? Write to us.