Skip to content

See where each alert went and whether it arrived

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/alerts/delivery
curl --request GET \  --url https://api.xovris.ai/v1/alerts/delivery \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
notificationId
required
string
incidentId
required
One of:
string
alertId
required
One of:
string
kind
required
string
severity
required
string
channel
required
string
Allowed values: push email met slack pagerduty teams telegram discord voice webhook in_app ntfy jsm incident_io rootly apprise sms whatsapp apns fcm
recipient
required
string
state
required
string
label
required
string
createdAt
required
string
acceptedAt
required
One of:
string
deliveredAt
required
One of:
string
acknowledgedAt
required
One of:
string
reroutedFrom
required
One of:
string
awaitingReport
required
boolean
delay
required
One of:
object
type
required
string
at
required
string
until
required
One of:
string
recipients
required
Array<object>
object
address
required
string
status
required
One of:
string
diagnostic
required
One of:
string
provider
required
string
attempts
required
Array<object>
object
no
required
number
state
required
string
provider
required
string
providerMessageId
required
One of:
string
code
required
One of:
string
startedAt
required
string
acceptedAt
required
One of:
string
deliveredAt
required
One of:
string
failedAt
required
One of:
string
why
required
One of:
string
next
required
One of:
string
fix
required
One of:
object
label
required
string
method
required
string
Allowed values: POST
path
required
string
quality
required
object
days
required
number
paged
required
number
actedOn
required
number
actedShare
required
One of:
number
timeToHuman
required
object
n
required
number
medianMs
required
One of:
number
p90Ms
required
One of:
number
pagedIds
required
Array<string>
actedIds
required
Array<string>
noise
required
object
sinceDays
required
number
incidents
required
number
onePerCause
required
number
figure
required
One of:
number
symptomsFolded
required
number
escalated
required
number
breaches
required
Array<object>
object
incidentId
required
string
channel
required
string
recipients
required
number
pages
required
number
words
required
string

Example

{  "items": [    {      "notificationId": "string",      "incidentId": "string",      "alertId": "string",      "kind": "string",      "severity": "string",      "channel": "push",      "recipient": "string",      "state": "string",      "label": "string",      "createdAt": "string",      "acceptedAt": "string",      "deliveredAt": "string",      "acknowledgedAt": "string",      "reroutedFrom": "string",      "awaitingReport": true,      "delay": {        "type": "string",        "at": "string",        "until": "string",        "recipients": [          {            "address": "string",            "status": "string",            "diagnostic": "string"          }        ],        "provider": "string"      },      "attempts": [        {          "no": 1,          "state": "string",          "provider": "string",          "providerMessageId": "string",          "code": "string",          "startedAt": "string",          "acceptedAt": "string",          "deliveredAt": "string",          "failedAt": "string"        }      ],      "why": "string",      "next": "string",      "fix": {        "label": "string",        "method": "POST",        "path": "string"      }    }  ],  "quality": {    "days": 1,    "paged": 1,    "actedOn": 1,    "actedShare": 1,    "timeToHuman": {      "n": 1,      "medianMs": 1,      "p90Ms": 1    },    "pagedIds": [      "string"    ],    "actedIds": [      "string"    ]  },  "noise": {    "sinceDays": 1,    "incidents": 1,    "onePerCause": 1,    "figure": 1,    "symptomsFolded": 1,    "escalated": 1,    "breaches": [      {        "incidentId": "string",        "channel": "string",        "recipients": 1,        "pages": 1      }    ],    "words": "string"  }}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.