Overview

Send Obkio network performance alerts to Callgoose SQIBS. An Obkio webhook posts each alert, and each recovery, to your SQIBS API endpoint. SQIBS opens an incident when packet loss, latency or jitter crosses a threshold and resolves it when the path is healthy again.

You need
An Obkio account (cloud or on-premises) with admin access, and a SQIBS API token
Setup time
About 10 minutes
Result
Obkio alerts open and resolve SQIBS incidents

How it works

Obkio
Alert fires
A network path breaks a threshold.
Obkio
Sends a webhook
Through a webhook, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
firing opens it, resolved 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 Obkio template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Resolve "data"."status" resolved Resolves the open incident.
Trigger "data"."status" firing Opens an incident.
Match "data"."alert_id" Ties the recovery to the incident it opened.
Title from "data"."alert_name" Becomes the incident title.
Description from "data"."description" Becomes the incident description.
  1. Choose the Priority for these incidents and click Save.

Obkio puts the alert inside a data object, so every key starts with "data".

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 Obkio

  1. In Obkio, go to Organization > Advanced Parameters > Webhooks (on-premises: Admin Portal > Webhooks) and add a webhook.
  2. Choose the JSON webhook type, method POST, and set the URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=obkio&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. Turn on recovery events, so incidents resolve. Save and enable the webhook, then use its test option.

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. Send a test from the webhook, or let a monitored path break a threshold.
  2. In SQIBS, a new incident opens. Obkio's payload looks like this (shortened):
{
  "type": "notification.triggered",
  "data": {
    "status": "firing",
    "alert_id": "obkio-alert-87426",
    "alert_name": "Packet loss high",
    "description": "Packet loss above 10% from HQ-EDGE to DC-GW",
    "severity": "critical"
  }
}
  1. When the path recovers, Obkio sends "status": "resolved" for the same alert_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 Obkio 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 Obkio reports packet loss on the primary link, SQIBS can run a workflow that collects interface errors and fails traffic over to the backup link.

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: