Skip to content

Tell your devices, in your order, that a session needs you

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/sessions/tell
curl --request POST \  --url https://api.xovris.ai/v1/sessions/tell \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "event": { "key": "string", "kind": "fixed", "blocking": true, "at": "string" }, "order": { "order": [ "push" ], "quiet": { "from": "string", "to": "string", "timeZone": "string" }, "escalateAfterMinutes": 1 }, "told": null }'

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

Media typeapplication/json
object
event
object
key
string
kind
string
Allowed values: fixed proven need changed-result broke
blocking
boolean
at
string
order
object
order
Array<string>
Allowed values: push email cli slack teams telegram discord sms whatsapp google-chat phone-app command-centre chat-thread call
quiet
object
from
required
string
to
required
string
timeZone
required
string
escalateAfterMinutes
number
told

Example

{  "event": {    "key": "string",    "kind": "fixed",    "blocking": true,    "at": "string"  },  "order": {    "order": [      "push"    ],    "quiet": {      "from": "string",      "to": "string",      "timeZone": "string"    },    "escalateAfterMinutes": 1  },  "told": null}

Done.

Media typeapplication/json
object
decision
required
One of:
object
tell
required
string
Allowed values: push email cli slack teams telegram discord sms whatsapp google-chat phone-app command-centre chat-thread call
deviceId
string
why
required
string
next
object
place
required
string
Allowed values: push email cli slack teams telegram discord sms whatsapp google-chat phone-app command-centre chat-thread call
at
required
string
presence
required
Array<object>
object
deviceId
string
place
required
string
Allowed values: cli phone-app command-centre chat-thread
focused
required
boolean
at
required
string

Example

{  "decision": {    "tell": "push",    "deviceId": "string",    "why": "string",    "next": {      "place": "push",      "at": "string"    }  },  "presence": [    {      "deviceId": "string",      "place": "cli",      "focused": true,      "at": "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.