Webhooks

Register a public HTTPS endpoint and obtain its signing secret once

Required API key scope: webhooks:write.

post/webhooks

Request

Request body

urlstring uri required

HTTPS endpoint that receives signed events. Public DNS resolution and destination restrictions apply; local/private addresses and redirects are rejected. At most five active endpoints per environment.

Response

Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

Changes

No recorded changes to this operation across all 1 revision of this API.