Overview

Send ServicePilot alerts to Callgoose SQIBS. An alert policy posts each alert to your SQIBS API endpoint through a webhook. SQIBS opens an incident when a resource goes critical and resolves it when it is OK again.

You need
ServicePilot with permission to manage policies, and a SQIBS API token
Setup time
About 15 minutes
Result
ServicePilot alerts open and resolve SQIBS incidents

How it works

ServicePilot
Alert fires
A resource changes to a critical state.
ServicePilot
Sends a webhook
An alert policy posts JSON to the webhook.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
CRITICAL opens it, OK 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 ServicePilot template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "state" CRITICAL Opens an incident.
Resolve "state" OK Resolves the open incident.
Match "servicepilot_event_id" Ties the resolve message to the incident it opened.
Title from "title" Becomes the incident title.
Description from "description" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Key value contains needs all its values in the message, so add one filter per state you want to page on (for example a second one for ALARM). These values follow the payload shown in the test step. Send one test notification first and confirm the keys with the JSON key creator: ServicePilot can change its payload between versions, and SQIBS matches key names exactly (upper and lower case matter).

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 alert policy in ServicePilot

  1. In ServicePilot, go to Policies > Alert Policies and add a policy of type webhook.
  2. Enter your SQIBS endpoint as the URL, with method POST and content type application/json:
https://<your-endpoint>/sqibs-api/v1/process?from=servicepilot&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. Use this body. ServicePilot replaces the <% %> placeholders with the alert's values:
{
  "servicepilot_event_id": "<% event.id %>",
  "state": "<% event.state %>",
  "severity": "<% event.severity %>",
  "title": "<% event.title %>",
  "description": "<% event.description %>",
  "host": "<% target.host %>",
  "service": "<% target.service %>"
}
  1. Choose the resources and states the policy applies to, then 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. Let a test resource go critical, or use the policy test option.
  2. In SQIBS, a new incident opens, titled with the alert title.
  3. When the resource is OK again, ServicePilot sends "state": "OK" for the same event id, 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 ServicePilot policy.

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 ServicePilot reports high CPU on the payments service, SQIBS can run a workflow that restarts the busiest worker.

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: