Skip to content

Read how alert delivery is doing across every channel

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
/api/alerts/delivery
curl --request GET \  --url https://api.xovris.ai/api/alerts/delivery \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
One of:
object
light
required
object
canvas
required
string
surface
required
string
panel
required
string
text
required
string
textMuted
required
string
border
required
string
link
required
string
actionBackground
required
string
actionText
required
string
severity
required
object
high
required
object
fg
required
string
bg
required
string
bar
required
string
medium
required
object
fg
required
string
bg
required
string
bar
required
string
low
required
object
fg
required
string
bg
required
string
bar
required
string
critical
required
object
fg
required
string
bg
required
string
bar
required
string
info
required
object
fg
required
string
bg
required
string
bar
required
string
check
required
object
failed
required
object
fg
required
string
bg
required
string
passed
required
object
fg
required
string
bg
required
string
pending
required
object
fg
required
string
bg
required
string
dark
required
object
canvas
required
string
surface
required
string
panel
required
string
text
required
string
textMuted
required
string
border
required
string
link
required
string
actionBackground
required
string
actionText
required
string
severity
required
object
high
required
object
fg
required
string
bg
required
string
bar
required
string
medium
required
object
fg
required
string
bg
required
string
bar
required
string
low
required
object
fg
required
string
bg
required
string
bar
required
string
critical
required
object
fg
required
string
bg
required
string
bar
required
string
info
required
object
fg
required
string
bg
required
string
bar
required
string
check
required
object
failed
required
object
fg
required
string
bg
required
string
passed
required
object
fg
required
string
bg
required
string
pending
required
object
fg
required
string
bg
required
string
font
required
object
sans
required
string
mono
required
string
size
required
object
small
required
string
body
required
string
title
required
string
space
required
object
xs
required
string
sm
required
string
md
required
string
lg
required
string
radius
required
object
sm
required
string
md
required
string
leading
string
tap
string
contentWidth
string
pageWidth
string
stackBelowPx
number
brandMark
object
tile
required
string
fold
required
string
size
required
string
logo
object
day
required
string
night
required
string
px
required
number
stage
object
ground
required
string
card
required
string
line
required
string
text
required
string
text2
required
string
text3
required
string
state
required
object
failed
required
string
passed
required
string
info
required
string
working
required
string
outlookFont
string
outlookMono
string

Example

{  "light": {    "canvas": "string",    "surface": "string",    "panel": "string",    "text": "string",    "textMuted": "string",    "border": "string",    "link": "string",    "actionBackground": "string",    "actionText": "string",    "severity": {      "high": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "medium": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "low": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "critical": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "info": {        "fg": "string",        "bg": "string",        "bar": "string"      }    },    "check": {      "failed": {        "fg": "string",        "bg": "string"      },      "passed": {        "fg": "string",        "bg": "string"      },      "pending": {        "fg": "string",        "bg": "string"      }    }  },  "dark": {    "canvas": "string",    "surface": "string",    "panel": "string",    "text": "string",    "textMuted": "string",    "border": "string",    "link": "string",    "actionBackground": "string",    "actionText": "string",    "severity": {      "high": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "medium": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "low": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "critical": {        "fg": "string",        "bg": "string",        "bar": "string"      },      "info": {        "fg": "string",        "bg": "string",        "bar": "string"      }    },    "check": {      "failed": {        "fg": "string",        "bg": "string"      },      "passed": {        "fg": "string",        "bg": "string"      },      "pending": {        "fg": "string",        "bg": "string"      }    }  },  "font": {    "sans": "string",    "mono": "string"  },  "size": {    "small": "string",    "body": "string",    "title": "string"  },  "space": {    "xs": "string",    "sm": "string",    "md": "string",    "lg": "string"  },  "radius": {    "sm": "string",    "md": "string"  },  "leading": "string",  "tap": "string",  "contentWidth": "string",  "pageWidth": "string",  "stackBelowPx": 1,  "brandMark": {    "tile": "string",    "fold": "string",    "size": "string"  },  "logo": {    "day": "string",    "night": "string",    "px": 1  },  "stage": {    "ground": "string",    "card": "string",    "line": "string",    "text": "string",    "text2": "string",    "text3": "string",    "state": {      "failed": "string",      "passed": "string",      "info": "string",      "working": "string"    }  },  "outlookFont": "string",  "outlookMono": "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.