Skip to main content
Error

Authorizations

ClientID
string
header
required
ApiKey
string
header
required

Body

application/json
WebhookName
string
required

Name of the webhook. Use a name that is unique within the account.

URL
string
required

Destination URL for the webhook.

Events
string[]
required

Event names from List webhook event names.

AccountID
string | null

Account for the webhook. Defaults to the account associated with your credentials.

Headers
object | null

Optional header names and values to send to the destination.

Response

Webhook created.

Code
integer

Application code in the response body. Separate from the HTTP status.

Message
string

Result message.

WebhookID
string

New webhook ID.