Skip to content

Read each escalation policy's newest drill, hop by hop

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

A token that can read is enough.

Done.

Media typeapplication/json
object
latest
required
Array<object>
object
incidentId
required
string
policyId
required
string
startedAt
required
string
state
required
string
ackWithinMinutes
required
number
deadline
required
string
outcome
required
string
secondsToHuman
required
One of:
number
acknowledgedBy
required
One of:
string
reachedLevel
required
number
hops
required
Array<object>
object
level
required
number
to
required
string
memberId
required
One of:
string
channel
required
string
queuedAt
required
string
acceptedAt
required
One of:
string
deliveredAt
required
One of:
string
acknowledgedAt
required
One of:
string
undelivered
required
Array<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
all
required
Array<object>
object
incidentId
required
string
policyId
required
string
startedAt
required
string
state
required
string

Example

{  "latest": [    {      "incidentId": "string",      "policyId": "string",      "startedAt": "string",      "state": "string",      "ackWithinMinutes": 1,      "deadline": "string",      "outcome": "string",      "secondsToHuman": 1,      "acknowledgedBy": "string",      "reachedLevel": 1,      "hops": [        {          "level": 1,          "to": "string",          "memberId": "string",          "channel": "string",          "queuedAt": "string",          "acceptedAt": "string",          "deliveredAt": "string",          "acknowledgedAt": "string"        }      ],      "undelivered": [        "push"      ]    }  ],  "all": [    {      "incidentId": "string",      "policyId": "string",      "startedAt": "string",      "state": "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.