Skip to main content
POST
Create webhook config

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

The customer endpoint URL to deliver webhooks to

Minimum string length: 1
Example:

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

events
string[]
required

List of event types to subscribe to, or ["AllEvents"] to subscribe to all supported event types including ones introduced in the future

Minimum array length: 1
Example:

Response

Created

id
string<uuid>

Unique identifier

accountId
string

Account identifier

applicationId
string

Application identifier

url
string

Endpoint URL

secret
string

Signing secret, returned only once in the create response; store it securely

subscribedEvents
string[]

Subscribed event types, or ["AllEvents"] when subscribed to all

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp