Your account

Webhooks

Send deploys, incidents, servers, backups, findings and billing changes to your own automation.

1. 1

   Add an endpoint

   Account → Webhooks → Add an endpoint. Give a public HTTPS address and choose the events, or Everything to get new kinds of event as they’re added. The signing secret is shown once.

2. 2

   What arrives

   A POST with JSON: id, event (such as deploy.succeeded, incident.opened, server.ready, backup.failed, security.finding or billing.plan_changed), created_at, account_id and data about what happened.

3. 3

   Check it came from us

   X-BuildPusher-Signature is v1= followed by HMAC-SHA256 of the X-BuildPusher-Timestamp header, a dot and the raw body, using the secret. The Webhooks page has a code sample. Ignore repeats of an X-BuildPusher-Delivery ID you’ve already handled.

4. 4

   Retries

   Answer with any 2xx within 10 seconds. Otherwise the delivery is tried up to six times over about three hours; after 20 failed deliveries in a row the endpoint is paused until you turn it back on. Send a test and Send again are on the same page, with the last deliveries’ results.

Still stuck? Email us, or send feedback from inside the app.