Skip to content

Create a webhook endpoint

POST
/api/webhooks/

Authorizations

Request Body required

object
url
required
string format: uri
events
required
Array<string>
>= 1 items
Allowed values: file.hot file.synced file.cold file.error
description
string

Responses

200

Default Response

object
webhook
required
object
id
required
string format: uuid
url
required
string format: uri
events
required
Array<string>
active
required
boolean
description
required
string
nullable
lastDeliveryStatus
required
string
nullable
lastDeliveryAt
nullable
failureCount
required
number
createdAt
updatedAt
secret
required
string

400

Default Response

object
error
required
string