Overview
Send GitLab events to Callgoose SQIBS. A project or group webhook posts the events you choose to your SQIBS API endpoint. SQIBS has a template for issues, merge requests, pushes and releases; the issue and merge request templates resolve the incident when the item is closed.
How it works
open opens it, close 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
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- In Select Integration Template, choose the GitLab template that fits the alerts you send. Each fills in its own filter values:
GitLab - Issue Event
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "object_attributes"."action" |
open |
Opens an incident. |
| Resolve | "object_attributes"."action" |
close |
Resolves the open incident. |
| Match | "object_attributes"."iid" |
Ties the resolve message to the incident it opened. | |
| Title from | "object_attributes"."title" |
Becomes the incident title. |
GitLab - Push Events
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "object_kind" |
push |
Opens an incident. |
GitLab - MergeEvents
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "object_attributes"."action" |
open |
Opens an incident. |
| Resolve | "object_attributes"."action" |
close |
Resolves the open incident. |
| Match | "object_attributes"."iid" |
Ties the resolve message to the incident it opened. |
GitLab - Release Events
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger | "action" |
create |
Opens an incident. |
- Choose the Priority for these incidents and click Save.
Use one filter per event type. The issue and merge request templates match on iid, which is only unique within one kind of item in one project; send each project to its own SQIBS service, or use Issue Event and MergeEvents on different services.
The template is a starting point, not a lock-in: every value stays visible and you can change it.
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 GitLab
- In GitLab, find your project or group, and in the left sidebar select Settings > Webhooks. Select Add new webhook.
- In URL, enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=gitlab&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.
- Under Trigger, tick the events you use: Issues events, Merge request events, Push events, Releases events.
- Select Add webhook.
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.
- In the webhook list, use Test and choose an event, for example Issues events.
- In SQIBS, a new incident opens, titled with the issue title. GitLab's issue payload looks like this (shortened):
{
"object_kind": "issue",
"project": {
"path_with_namespace": "example/shop-api"
},
"object_attributes": {
"iid": 23,
"title": "Checkout total is wrong",
"state": "opened",
"action": "open",
"url": "https://gitlab.com/example/shop-api/-/issues/23"
}
}
- Close the issue. GitLab sends
"action": "close"for the sameiid, and 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 GitLab 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 merge request labelled hotfix is opened, SQIBS can run a workflow that starts the hotfix pipeline checks and posts the result to the incident.
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:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- 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:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.