Overview

Send Buildkite build results to Callgoose SQIBS. A webhook notification service posts build events to your SQIBS API endpoint. SQIBS opens an incident when a build fails and resolves it when the next build of the same pipeline passes.

You need
A Buildkite organization where you are an admin, and a SQIBS API token
Setup time
About 10 minutes
Result
Failed builds open SQIBS incidents; passing builds resolve them

How it works

Buildkite
Alert fires
A build finishes with state failed.
Buildkite
Sends a webhook
A webhook notification service posts build.finished.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
failed opens it, passed closes it.

Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.

Step 1: Add the API filter in SQIBS

  1. In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
  2. Add a filter with these values (there is no built-in Buildkite template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "build"."state" failed Opens an incident.
Resolve "build"."state" passed Resolves the open incident.
Match "pipeline"."slug" The pipeline ties the next good build to the failure.
Title from "build"."message" Becomes the incident title.
Description from "build"."web_url" A link to the build.
  1. Choose the Priority for these incidents and click Save.

Not sure of a key? Send one test message first (step below), then build the filter from the real payload.

Find the right key with the JSON key creator
In the API Integration window, click the round {} button at the bottom right. Paste a payload that SQIBS received (copy it from the API log). SQIBS lists every key with its value, each with a copy button. Copy the key into Payload JSON key and the value into Key value contains. No need to read the JSON by hand.

Step 2: Add a webhook in Buildkite

  1. In Buildkite, open Organization Settings > Integrations > Notification Services, and add a Webhook.
  2. In Webhook URL, enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=buildkite&token=<your-token>

Replace <your-endpoint> and <your-token> with the values from your SQIBS account. See how to get the endpoint URL and API tokens.

The token must be in the URL. Buildkite's own Token setting is sent as an X-Buildkite-Token header, which SQIBS does not read.

  1. Under Events, choose build.finished.
  2. Choose the pipelines to include (all, or selected) and save.

Step 3: Test it

The API log saves payloads only while API Tracking is on for the token. Turn it on under API Tokens before you test; it switches itself off after 48 hours.

  1. Run a build that fails.
  2. In SQIBS, a new incident opens, titled with the build message. Buildkite's payload looks like this (shortened):
{
  "event": "build.finished",
  "build": {
    "id": "0190a1b2-c3d4-4e5f-8a9b-0c1d2e3f4a5b",
    "number": 42,
    "state": "failed",
    "message": "Fix checkout total",
    "branch": "main",
    "web_url": "https://buildkite.com/example/shop-api/builds/42"
  },
  "pipeline": {
    "slug": "shop-api",
    "name": "Shop API"
  }
}
  1. Fix the build. When the next build of the pipeline passes, SQIBS resolves the incident.

No incident? Open the API log (with API Tracking on). If the payload is there, the filter did not match it: paste it into the JSON key creator and check the keys. If it is not there, check the URL and token in the Buildkite webhook.

Fix known issues automatically

Many alerts have a known fix: restart a service, clear a full disk, run a health check. SQIBS can run that fix for you the moment the incident opens. This is event-driven auto remediation. For example, when a build fails on an agent that ran out of disk, SQIBS can run a workflow that prunes the agent's Docker images and retries the build.

Incident opens
Workflow starts
SQIBS runs the automation workflow linked to the filter.
Fixed
Incident resolved
The issue is fixed before anyone has to step in.
Not fixed
Escalated to the engineer
After the waiting time you set, the escalation policy pages on-call as usual.

Safe by design. SQIBS runs only workflows your own engineers wrote and approved for your environment. Nothing is guessed or generated: the same steps an engineer would run by hand, run sooner. If the workflow does not fix the issue, the engineer is paged as usual.

To set it up, in the same API filter:

  1. Select Workflow: choose the automation workflow to run when this filter opens an incident.
  2. If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
  3. Waiting time for escalate to escalation policies: how many minutes to give the workflow before paging the on-call engineer.

Start with low-risk workflows, such as a health check, and add fixes as you come to trust them.

Learn more: