Overview
Know when Vonage messages fail. The Vonage Messages API posts a JSON status event for every message to your application's status URL. Point it at your SQIBS API endpoint and SQIBS opens an incident for each rejected or undelivered message.
How it works
rejected or undelivered opens it.Want SQIBS to fix known issues before anyone is paged? See Fix known issues automatically.
Step 1: Add the API filter in SQIBS
- In SQIBS, open Services, choose the service that should receive these incidents, and click Add Or Update API Integration.
- Add a filter with these values (there is no built-in Vonage template yet, so enter them by hand):
| Part | Payload JSON key | Key value contains | What it does |
|---|---|---|---|
| Trigger (filter 1) | "status" |
rejected |
Opens an incident for rejected messages. |
| Trigger (filter 2) | "status" |
undelivered |
Opens an incident for undelivered messages. |
| Trigger (filter 3) | "status" |
failed |
Opens an incident for failed messages. |
| Match | "message_uuid" |
One incident per message. | |
| Title from | "error"."title" |
The error becomes the incident title. | |
| Description from | "error"."detail" |
Becomes the incident description. |
- Choose the Priority for these incidents and click Save.
Add each numbered row as its own filter (same Match values). SQIBS needs every value in Key value contains to be present, so several values in one filter would never match.
Vonage also sends submitted, delivered and read events. They match no filter, so SQIBS ignores them.
Not sure of a key? Send one test message first (step below), then build the filter from the real payload.
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: Set the status URL in Vonage
- In the Vonage dashboard, open Applications and edit the application that sends your messages.
- Under Capabilities > Messages, set Status URL to your SQIBS endpoint and the method to POST:
https://<your-endpoint>/sqibs-api/v1/process?from=vonage&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.
- Save the application. If your status URL already points at your own service, forward failed events to SQIBS from there 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.
- Send a message to an invalid number, for a test.
- In SQIBS, a new incident opens. The status event looks like this (shortened):
{
"message_uuid": "aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab",
"to": "6590000000",
"from": "Shop",
"timestamp": "2026-11-22T10:15:00Z",
"status": "rejected",
"channel": "sms",
"error": {
"type": "https://developer.vonage.com/api-errors/messages#1320",
"title": "1320",
"detail": "Invalid destination number"
}
}
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 application status 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 many messages are rejected at once, SQIBS can run a workflow that checks your Vonage balance and sender settings and switches to a backup provider.
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:
- Select Workflow: choose the automation workflow to run when this filter opens an incident.
- If success then make incident resolved: turn on to resolve the incident when the workflow succeeds.
- 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:
- Prometheus: incident auto remediation, a full worked example.
- Automation workflow: build a workflow from actions.
- Run workflows where your systems are: SSH, Bash, PowerShell, Python, Ansible, kubectl, Terraform.