Overview

Plivo sends a delivery status callback for each SMS your application sends. If you point the callback of important messages (for example one-time passcodes or customer alerts) at SQIBS, SQIBS opens an incident when a message fails, so a delivery problem is noticed before customers report it.

You need
A Plivo account and an application that sends SMS with Plivo, and a SQIBS API token
Setup time
About 15 minutes
Result
Failed Plivo deliveries open SQIBS incidents

How it works

Plivo
Alert fires
A message ends as failed or undelivered.
Plivo
Sends a webhook
Plivo posts the status callback to the URL set on the message.
SQIBS
API filter matches
The filter decides whether to open or resolve, and the priority.
SQIBS
Incident opens
Failed deliveries open an incident.

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 Plivo template yet, so enter them by hand):
Part Payload JSON key Key value contains What it does
Trigger (none) Status=failed Opens an incident for failed messages.
Trigger (none) Status=undelivered A second filter for undelivered messages.
  1. Choose the Priority for these incidents and click Save.

Plivo posts form data, not JSON, so there are no JSON keys to match. Leave Payload JSON key empty: SQIBS then checks Key value contains against the whole message. Without JSON keys SQIBS cannot take a title from the message or tie a recovery to its incident, so these incidents are closed in SQIBS. Delivered and sent callbacks match neither filter and are ignored.

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: Send the callbacks to SQIBS

The status callback URL is set per message, in the url parameter of the send request. Use the SQIBS endpoint for the messages you want watched, with method POST (with GET the details are in the URL, which SQIBS does not read):

https://<your-endpoint>/sqibs-api/v1/process?from=plivo&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.

The callback then goes to SQIBS instead of your own application. If your application needs the callbacks too, keep them on your application and have it forward only failures to SQIBS as JSON (for example {"status": "failed", "message_uuid": "...", "error_code": "..."}), and filter on "status" instead.

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 message to a number that cannot receive it.
  2. When Plivo reports it failed, a new incident opens in SQIBS.

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 message's callback URL.

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 OTP messages start failing, SQIBS can run a workflow that switches your application to the backup SMS route.

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: