Overview

Send LibreNMS network alerts to Callgoose SQIBS. The API alert transport posts each alert and recovery to your SQIBS API endpoint as JSON. SQIBS opens an incident when an alert is raised and resolves it when LibreNMS reports the recovery.

You need
LibreNMS with admin access to alert transports and rules, and a SQIBS API token
Setup time
About 15 minutes
Result
LibreNMS alerts open and resolve SQIBS incidents

How it works

LibreNMS
Alert fires
An alert rule matches a device.
LibreNMS
Sends a webhook
The API transport posts JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
State 1 opens it, 0 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 LibreNMS template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "state" 1 Opens an incident (1 = alert).
Resolve "state" 0 Resolves the open incident (0 = recovered).
Match "alert_id" Ties the recovery to the incident it opened.
Title from "title" Becomes the incident title.
  1. Choose the Priority for these incidents and click Save.

LibreNMS also sends 2 (acknowledged), 3 (got worse) and 4 (got better). They match neither filter, so they do not open new incidents.

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: Create the API transport in LibreNMS

  1. In LibreNMS, go to Alerts > Alert Transports and click Create alert transport.
  2. Name it Callgoose SQIBS and choose the transport type API.
  3. Set API Method to POST and API URL to your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=librenms&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 API Headers, add Content-Type=application/json. In API Body, paste:
{
  "state": "{{ $state }}",
  "alert_id": "{{ $id }}",
  "hostname": "{{ $hostname }}",
  "title": "{{ $title }}",
  "severity": "{{ $severity }}",
  "rule": "{{ $name }}",
  "timestamp": "{{ $timestamp }}"
}
  1. Leave Send as form off and save the transport.

Step 3: Use the transport in your alert rules

Go to Alerts > Alert Rules, edit a rule (or create one), and select Callgoose SQIBS under Transports. Make sure the rule sends recoveries (Recovery alerts on). Save the rule.

Step 4: 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. Use Test on the transport, or take a test device offline.
  2. In SQIBS, a new incident opens, titled with the alert title.
  3. Bring the device back. LibreNMS sends "state": "0" with 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 API transport.

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 LibreNMS reports a port down on a switch, SQIBS can run a workflow that bounces the port and checks it comes back.

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: