Skip to content

List the alerts raised in your workspace

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

A token that can read is enough.

Done.

Media typeapplication/json
One of:
object
now
required
string
channels
required
Array<object>
object
channelId
required
string
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
health
required
string
reason
required
One of:
string
since
required
One of:
string
last24h
required
object
accepted
required
number
delivered
required
number
failed
required
number
bounced
required
number
queued
required
number
held
required
number
lastDelivery
One of:
object
at
required
string
state
required
string
answeredMs
required
One of:
number
deliveredAfterMs
required
One of:
number
target
required
string
workspace
required
One of:
string
paused
required
boolean
paths
required
Array<object>
object
path
required
string
state
required
string
since
required
string
reason
required
One of:
string
killSwitches
required
Array<object>
object
scope
required
string
reason
required
string
since
required
string
tests
required
Array<object>
object
id
required
string
channel
required
string
Allowed values: email slack
state
required
string
Allowed values: failed queued accepted delivered bounced
requestedAt
required
string
providerReportedAt
required
One of:
string
providerReference
required
One of:
string
failure
required
One of:
object
code
required
string
message
required
string
fallbackOf
required
One of:
string
testId
required
One of:
string
channelId
required
One of:
string
channelLabel
required
One of:
string
attempts
required
number
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
recent
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
builtInEmail
required
object
added
required
boolean
suggested
required
One of:
string
timings
required
object
holds
required
Array<object>
object
minutes
required
number
said
required
string
repeat
required
One of:
object
times
required
number
afterMinutes
required
One of:
number

Example

{  "now": "string",  "channels": [    {      "channelId": "string",      "kind": "push",      "label": "string",      "health": "string",      "reason": "string",      "since": "string",      "last24h": {        "accepted": 1,        "delivered": 1,        "failed": 1,        "bounced": 1,        "queued": 1,        "held": 1      },      "lastDelivery": {        "at": "string",        "state": "string",        "answeredMs": 1,        "deliveredAfterMs": 1      },      "target": "string",      "workspace": "string",      "paused": true    }  ],  "paths": [    {      "path": "string",      "state": "string",      "since": "string",      "reason": "string"    }  ],  "killSwitches": [    {      "scope": "string",      "reason": "string",      "since": "string"    }  ],  "tests": [    {      "id": "string",      "channel": "email",      "state": "failed",      "requestedAt": "string",      "providerReportedAt": "string",      "providerReference": "string",      "failure": {        "code": "string",        "message": "string"      },      "fallbackOf": "string",      "testId": "string",      "channelId": "string",      "channelLabel": "string",      "attempts": 1,      "delay": {        "type": "string",        "at": "string",        "until": "string",        "recipients": [          {            "address": "string",            "status": null,            "diagnostic": null          }        ],        "provider": "string"      }    }  ],  "recent": [    {      "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": null,            "diagnostic": null          }        ],        "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"      }    }  ],  "builtInEmail": {    "added": true,    "suggested": "string"  },  "timings": {    "holds": [      {        "minutes": 1,        "said": "string"      }    ],    "repeat": {      "times": 1,      "afterMinutes": 1    }  }}

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.