Overview

Send Usersnap bug reports and feedback to Callgoose SQIBS. A Usersnap webhook integration posts each new item to your SQIBS API endpoint, and SQIBS opens an incident for it. Use a filter value to page only on the items that matter, for example reports marked high priority.

You need
A Usersnap project with admin access, and a SQIBS API token
Setup time
About 10 minutes
Result
Usersnap reports open SQIBS incidents

How it works

Usersnap
Alert fires
A user submits a bug report or feedback.
Usersnap
Sends a webhook
Through the webhook integration, as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
SQIBS opens an incident for the report.

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 Usersnap template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger (none) No key yet: every report opens an incident.
  1. Choose the Priority for these incidents and click Save.

Send one test report first, then use the JSON key creator to add a key such as the report's priority or label, so only urgent reports page someone.

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 the webhook in Usersnap

  1. In Usersnap, open the project (or survey) and go to its Connect and Manage settings, then Integrations.
  2. Choose Webhook and enter your SQIBS endpoint:
https://<your-endpoint>/sqibs-api/v1/process?from=usersnap&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. Click Connect Now and 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. Submit a test report from your site's Usersnap widget.
  2. In SQIBS, a new incident opens. Open the payload in the JSON key creator to choose the title, description and priority keys.

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 Usersnap integration.

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 users report a broken checkout page, SQIBS can run a workflow that runs a synthetic check of the checkout and attaches the result to the incident.

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: