Overview

Everything you send to SQIBS, from a monitoring webhook to your own script, goes to one of two endpoints: /v1/process opens or resolves incidents, /v1/request creates requests that run workflows. You add your API token and, optionally, a from label.

You need
An API token
Where
API Tokens > API Info shows your Base URL
Result
The URL to give your tools

Build the URL

  1. In SQIBS, open API Tokens. API Info shows your Base URL, for example https://sqibs.callgoose.com/sqibs-api.
  2. Add the endpoint:
To Endpoint Example
Open or resolve incidents /v1/process https://sqibs.callgoose.com/sqibs-api/v1/process
Create requests (run workflows) /v1/request https://sqibs.callgoose.com/sqibs-api/v1/request
  1. Add the token, in one of two ways:

    • Header (preferred): Authorization: Bearer <your-token>. The URL stays as it is.
    • URL parameter, for tools that cannot set headers: add ?token=<your-token>.
  2. Optional: add from=<label>, for example from=Prometheus. SQIBS uses it in incident titles.

https://sqibs.callgoose.com/sqibs-api/v1/process?from=Prometheus&token=<your-token>

How SQIBS titles incidents

The payload has the filter's Incident title from key With from=Prometheus Without from
Yes Prometheus - <value of the key> <value of the key>
No (or not JSON) Incident from Prometheus Incident from Unspecified source

The description is the value of the Incident description from key, or the whole payload if that key is not set or missing. Requests are titled Request from <from> and use the payload as description.

Send JSON for the best results. SQIBS accepts any text payload (JSON, plain text, XML, HTML, form data); audio, images, video and multipart uploads are treated as empty.