Skip to content

Add a webhook

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/webhooks
curl --request POST \  --url https://api.xovris.ai/v1/webhooks \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "url": null, "eventTypes": null, "description": 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
url
eventTypes
description

Example

{  "url": null,  "eventTypes": null,  "description": null}

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

Media typeapplication/json
object
endpoint
required
object
placedIn
required
Array<object>
object
provider
required
string
Allowed values: vercel
configurationId
required
string
projectId
required
string
project
required
string
variable
required
string
envId
required
string
targets
required
Array<string>
readBack
required
boolean
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
secret
required
string
firstTest
required
object
deliveryId
required
One of:
string
queued
required
boolean
placed
required
Array<object>
object
provider
required
string
Allowed values: vercel
configurationId
required
string
projectId
required
string
project
required
string
variable
required
string
envId
required
string
targets
required
Array<string>
readBack
required
boolean
secretNote
required
string

Example

{  "endpoint": {    "placedIn": [      {        "provider": "vercel",        "configurationId": "string",        "projectId": "string",        "project": "string",        "variable": "string",        "envId": "string",        "targets": [          "string"        ],        "readBack": true      }    ],    "id": null,    "url": null,    "description": null,    "eventTypes": null,    "enabled": null,    "disabledReason": {},    "consecutiveFailures": null,    "createdAt": "string",    "receiverCheck": {},    "receiverCheckedAt": "string"  },  "secret": "string",  "firstTest": {    "deliveryId": "string",    "queued": true  },  "placed": [    {      "provider": "vercel",      "configurationId": "string",      "projectId": "string",      "project": "string",      "variable": "string",      "envId": "string",      "targets": [        "string"      ],      "readBack": true    }  ],  "secretNote": "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.