Skip to main content
POST
Create a webhook registration

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 HTTPS URL for your webhook callback. For more information, see Enabling Webhooks.

Example:

"https://api.yourdomain.com/webhooks/push"

secret
string

A cryptographically random string of at least 32 characters. If omitted, events are delivered unsigned. For more information, see Enabling Webhooks.

Required string length: 32 - 4096
Example:

"whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

Response

Webhook registration updated

A webhook registration for global events

url
string
required

The registered URL. The secret is not returned.