Create a new webhook

Creates a new webhook, which will be triggered on the specified events

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Body Params
string
required
length ≥ 1

The url of the webhook where notifications will be sent. URL must be valid, unique and https.

string
length ≥ 1

description of the webhook. should not contain special characters.

events
array of objects
required

event types the webhook will subscribe to

events*
boolean
Defaults to true

The status of the webhook. If false, the webhook will not receive notifications.

Headers
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json