Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

Body

application/json
url
string
required

Webhook URL to send the payload, only HTTPS supported

Minimum string length: 1
Example:

"https://api.example.com/webhook"

events
string[]

List of events that will trigger the webhook call, if empty all events will be used

Example:

Response

Created webhook

status
enum<string>
required

Successful reponse status

Available options:
success
Example:

"success"

webhook
object
required

The webhook data