Skip to content

Acknowledge an incident from wherever its alert reached you (the place is written to its record)

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.

POST
/v1/incidents/{id}/ack
curl --request POST \  --url https://api.xovris.ai/v1/incidents/example/ack \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "place": "push" }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object
place
string
Allowed values: push email phone app slack teams centre toast

Example

{  "place": "push"}

Done.

Media typeapplication/json
object
id
required
string
triage
required
object
snoozed
required
One of:
object
until
required
One of:
string
untilWorse
required
boolean
untilActivity
required
boolean
by
required
string
at
required
string
words
required
string
woke
required
One of:
object
at
required
One of:
string
because
required
string
Allowed values: person time worse activity
words
required
string
muted
required
One of:
object
until
required
string
by
required
string
at
required
string
words
required
string
mergedInto
required
One of:
object
id
required
string
by
required
string
at
required
string
mergedFrom
required
Array<string>
owner
required
One of:
string
watchers
required
Array<string>
acked
required
One of:
object
by
required
string
at
required
string
from
required
string
Allowed values: push email phone app slack teams centre toast
words
required
string
pinnedBy
required
Array<string>

Example

{  "id": "string",  "triage": {    "snoozed": {      "until": "string",      "untilWorse": true,      "untilActivity": true,      "by": "string",      "at": "string",      "words": "string"    },    "woke": {      "at": "string",      "because": "person",      "words": "string"    },    "muted": {      "until": "string",      "by": "string",      "at": "string",      "words": "string"    },    "mergedInto": {      "id": "string",      "by": "string",      "at": "string"    },    "mergedFrom": [      "string"    ],    "owner": "string",    "watchers": [      "string"    ],    "acked": {      "by": "string",      "at": "string",      "from": "push",      "words": "string"    },    "pinnedBy": [      "string"    ]  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.