Overview

Send new Firebase Crashlytics crash issues to Callgoose SQIBS. Crashlytics has no generic webhook, but Cloud Functions for Firebase can run on Crashlytics alerts. A short function posts each new fatal issue to your SQIBS API endpoint, and SQIBS opens an incident.

You need
A Firebase project on the Blaze plan with Crashlytics, the Firebase CLI, and a SQIBS API token
Setup time
About 20 minutes
Result
New fatal crash issues open SQIBS incidents

How it works

Crashlytics
Alert fires
A new fatal issue is detected.
Crashlytics
Sends a webhook
A Cloud Function posts it as JSON.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
The incident takes its title from the issue.

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 Firebase Crashlytics template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger "type" new_fatal_issue Opens an incident.
Match "issue_id" Groups repeats of the same issue.
Title from "title" The issue title and app version.
Description from "subtitle" Where the crash happened.
  1. Choose the Priority for these incidents and click Save.

Crashlytics does not send an alert when an issue is closed, so resolve the incident in SQIBS when the fix ships. Other Crashlytics alerts (regressions, velocity) have their own triggers; add a function for each with its own type.

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: Deploy the alert function

  1. In your Firebase project's functions folder, store the token: firebase functions:secrets:set SQIBS_TOKEN.
  2. Add this function:
// functions/index.js (Cloud Functions for Firebase, 2nd gen)
const {onNewFatalIssuePublished} = require("firebase-functions/v2/alerts/crashlytics");
const {defineSecret} = require("firebase-functions/params");
const SQIBS_TOKEN = defineSecret("SQIBS_TOKEN");

exports.crashlyticsToSqibs = onNewFatalIssuePublished({secrets: [SQIBS_TOKEN]}, async (event) => {
  const issue = event.data.payload.issue;
  await fetch("https://<your-endpoint>/sqibs-api/v1/process?from=crashlytics", {
    method: "POST",
    headers: {"Content-Type": "application/json", "Authorization": `Bearer ${SQIBS_TOKEN.value()}`},
    body: JSON.stringify({
      type: "new_fatal_issue",
      app_id: event.appId,
      issue_id: issue.id,
      title: `${issue.title} (${issue.appVersion})`,
      subtitle: issue.subtitle,
    }),
  });
});

Replace <your-endpoint> with your SQIBS endpoint host. See how to get the endpoint URL. 3. Deploy it with firebase deploy --only functions.

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. Force a test crash in a debug build (the Crashlytics SDK has a test crash call), then reopen the app so the report uploads.
  2. When Crashlytics publishes the new fatal issue, the function runs and SQIBS opens an 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 function logs in the Firebase console.

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 a new fatal issue appears right after a release, SQIBS can run a workflow that halts the staged rollout and notifies the release owner.

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: