Overview

Send TeamCity build results to Callgoose SQIBS. TeamCity webhooks are turned on with project parameters and post each finished build to your SQIBS API endpoint. SQIBS opens an incident when a build fails and resolves it when the same build configuration succeeds again.

You need
TeamCity 2024.07 or later with project admin access, and a SQIBS API token
Setup time
About 10 minutes
Result
Failed builds open SQIBS incidents; green builds resolve them

How it works

TeamCity
Alert fires
A build finishes with a failure.
TeamCity
Sends a webhook
A webhook posts the build as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
Status FAILURE opens it, SUCCESS 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 TeamCity. It fills in these filter values:
Part Payload JSON key Key value contains What it does
Trigger "payload"."status" failure Opens an incident.
Resolve "payload"."status" success Resolves the open incident.
Match "payload"."buildTypeId" Ties the resolve message to the incident it opened.
Title from "eventType" Becomes the incident title.
Description from "payload"."statusText" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

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: Turn on webhooks in TeamCity

Webhooks are set with configuration parameters (Administration > project > Parameters > Add new parameter). Leave Kind and Value type as they are.

  1. In the Root project, add teamcity.internal.webhooks.enable with the value true.
  2. In the Root project, add teamcity.internal.webhooks.url with your SQIBS endpoint as the value:
https://<your-endpoint>/sqibs-api/v1/process?from=teamcity&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. In each project you want to watch, add teamcity.internal.webhooks.events with the value BUILD_FINISHED (separate more events with ;, for example BUILD_FINISHED;BUILD_INTERRUPTED).
  2. Optional: keep the payload small with teamcity.internal.webhooks.BUILD_FINISHED.fields set to:
fields=buildTypeId,number,status,statusText,branchName,webUrl,buildType(projectName,projectId)

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, described with the build's status text. TeamCity's payload looks like this:
{
  "eventType": "BUILD_FINISHED",
  "payload": {
    "buildTypeId": "ShopApi_Build",
    "number": "32",
    "status": "FAILURE",
    "statusText": "Tests failed: 3 (3 new), passed: 412",
    "branchName": "main",
    "buildType": {
      "projectName": "Shop API",
      "projectId": "ShopApi"
    }
  }
}
  1. Fix the build and run it again. When it finishes with SUCCESS for the same buildTypeId, 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 TeamCity parameters.

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 build 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: