Skip to content

Send alerts from another tool

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/hooks/alerts/{tenant}/{connection}
curl --request POST \  --url https://api.xovris.ai/v1/hooks/alerts/example/example \  --header 'Content-Type: application/json' \  --data '{ "event_id": "string", "id": "string", "MessageId": "string", "alerts": null, "title": "string", "message": "string", "externalURL": "string", "data": null, "action": null, "aggreg_key": null, "alert_id": null, "alert_transition": null, "priority": null, "alert_type": null, "body": null, "hostname": "string", "link": "string", "tags": null, "event": null, "source": null, "dedup_key": null, "status": null, "severity": null, "description": null, "asset": "string", "url": "string", "labels": {}, "starts_at": "string" }'

Open to anyone, so no Idempotency-Key is kept: nobody is signed in to keep it for, and replaying one caller’s answer to another would hand it over.

No token needed: anyone may call this.

tenant
required
string
connection
required
string
Media typeapplication/json
object
event_id
string
id
string
MessageId
string
alerts
title
string
message
string
externalURL
string
data
action
aggreg_key
alert_id
alert_transition
priority
alert_type
body
hostname
string
link
string
tags
event
source
dedup_key
status
severity
description
asset
string
url
string
labels
object
key
additional properties
string
starts_at
string

Example

{  "event_id": "string",  "id": "string",  "MessageId": "string",  "alerts": null,  "title": "string",  "message": "string",  "externalURL": "string",  "data": null,  "action": null,  "aggreg_key": null,  "alert_id": null,  "alert_transition": null,  "priority": null,  "alert_type": null,  "body": null,  "hostname": "string",  "link": "string",  "tags": null,  "event": null,  "source": null,  "dedup_key": null,  "status": null,  "severity": null,  "description": null,  "asset": "string",  "url": "string",  "labels": {},  "starts_at": "string"}

Done.

Media typeapplication/json
One of:
object
duplicate
required
boolean
deliveryId
required
string

Example

{  "duplicate": true,  "deliveryId": "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

{}

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.