Skip to content

List webhooks

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

A token that can read is enough.

Done.

Media typeapplication/json
object
eventTypes
required
Array
endpoints
required
Array<object>
object
deliveries
required
Array<object>
object
id
required
eventId
required
eventType
required
status
required
attempts
required
lastStatus
required
One of:
object
lastError
required
One of:
object
nextAttemptAt
required
One of:
string
deliveredAt
required
One of:
string
createdAt
required
One of:
string
attemptLog
required
Array<object>
object
n
required
at
required
One of:
string
statusCode
required
One of:
object
durationMs
required
error
required
One of:
object
id
required
url
required
description
required
eventTypes
required
enabled
required
disabledReason
required
One of:
object
consecutiveFailures
required
createdAt
required
One of:
string
receiverCheck
required
One of:
object
receiverCheckedAt
required
One of:
string

Example

{  "eventTypes": [    "alert.fired"  ],  "endpoints": [    {      "deliveries": [        {          "id": null,          "eventId": null,          "eventType": null,          "status": null,          "attempts": null,          "lastStatus": {},          "lastError": {},          "nextAttemptAt": "string",          "deliveredAt": "string",          "createdAt": "string",          "attemptLog": [            {              "n": null,              "at": "string",              "statusCode": {},              "durationMs": null,              "error": {}            }          ]        }      ],      "id": null,      "url": null,      "description": null,      "eventTypes": null,      "enabled": null,      "disabledReason": {},      "consecutiveFailures": null,      "createdAt": "string",      "receiverCheck": {},      "receiverCheckedAt": "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.