Skip to content

List the channels Xovris reaches people through on this server, each live because its door is configured

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

A token that can read is enough.

Done.

Media typeapplication/json
object
facts
required
Array<object>
object
kind
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
label
required
string
short
required
string
subject
required
string
via
required
string
live
required
boolean
cost
required
One of:
object
kind
required
string
Allowed values: included
arrival
required
string
Allowed values: accepted delivered
buttons
required
boolean
replies
required
boolean
breaksThrough
required
string
Allowed values: none critical time_sensitive repeat_call
where
required
One of:
object
kind
required
string
Allowed values: everywhere
plan
required
string
Allowed values: every paid
hourlyQuota
required
number
device
required
boolean
pickable
required
boolean
awaiting
string
grant
object
asks
required
Array<string>
Allowed values: service region
yours
required
string
connected
required
string
off
required
object
key
additional properties
string

Example

{  "facts": [    {      "kind": "push",      "label": "string",      "short": "string",      "subject": "string",      "via": "string",      "live": true,      "cost": {        "kind": "included"      },      "arrival": "accepted",      "buttons": true,      "replies": true,      "breaksThrough": "none",      "where": {        "kind": "everywhere"      },      "plan": "every",      "hourlyQuota": 1,      "device": true,      "pickable": true,      "awaiting": "string",      "grant": {        "asks": [          "service"        ],        "yours": "string",        "connected": "string"      }    }  ],  "off": {}}

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.