Overview

Send Bitbucket Pipelines events to Callgoose SQIBS. A repository webhook posts build status, push and pull request events to your SQIBS API endpoint. SQIBS opens an incident when a build fails and resolves it when the next build succeeds.

You need
A Bitbucket Cloud repository where you are an admin, and a SQIBS API token
Setup time
About 10 minutes
Result
Failed builds open SQIBS incidents; green builds resolve them

How it works

Bitbucket
Alert fires
A pipeline build fails.
Bitbucket
Sends a webhook
Through a repository webhook, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
FAILED opens it, SUCCESSFUL 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. In Select Integration Template, choose the Bitbucket Pipelines template that fits the alerts you send. Each fills in its own filter values:

Bitbucket Pipelines - Build Status Event

Part Payload JSON key Key value contains What it does
Trigger "commit_status"."state" failed Opens an incident.
Resolve "commit_status"."state" successful Resolves the open incident.
Match "repository"."owner"."username" Ties the resolve message to the incident it opened.
Title from "commit_status"."name" Becomes the incident title.
Description from "commit_status"."commit"."message" Becomes the incident description.

Bitbucket Pipelines - Push Event

Part Payload JSON key Key value contains What it does
Trigger "push" (anything) Opens an incident.
Title from "push"."changes".[0]."new"."name" Becomes the incident title.
Description from "push"."changes".[0]."new" Becomes the incident description.

Bitbucket Pipelines - Merge Event

Part Payload JSON key Key value contains What it does
Trigger "pullrequest"."state" open Opens an incident.
Resolve "pullrequest"."state" merged Resolves the open incident.
Match "repository"."owner"."username" Ties the resolve message to the incident it opened.
Title from "pullrequest"."title" Becomes the incident title.
Description from "pullrequest"."description" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Most teams only need Build Status Event. It matches the resolve message on the repository owner's username, which is empty for workspaces and ties every repository of an owner together. Change Map incident with (trigger and resolve) to "repository"."full_name" so each repository has its own incident.

The template is a starting point, not a lock-in: every value stays visible and you can change it.

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 Bitbucket

  1. In the repository, open Repository settings and, under Workflow, choose Webhooks. Click Add webhook.
  2. Set Title to CallgooseSQIBS and URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=bitbucket&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.

  1. Under Triggers, choose from the full list: Build status created and Build status updated for builds; add Push or pull request Merged only if you use those templates.
  2. Click 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. Push a commit that fails the pipeline.
  2. In SQIBS, a new incident opens, titled with the build name and described with the commit message. The build status payload looks like this (shortened):
{
  "commit_status": {
    "name": "Pipeline #142 for main",
    "state": "FAILED",
    "key": "pipeline",
    "url": "https://bitbucket.org/example/shop-api/pipelines/results/142",
    "commit": {
      "hash": "9fec847",
      "message": "Fix checkout total"
    }
  },
  "repository": {
    "full_name": "example/shop-api",
    "name": "shop-api"
  }
}
  1. Fix the build and push again. When the build is SUCCESSFUL, 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 Bitbucket 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 deployment pipeline fails, SQIBS can run a workflow that checks the target environment and rolls back to the last good release.

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: