Skip to main content
POST
Create a webhook subscription

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Body

application/json
url
string<uri>
required

Delivery endpoint. Must use https:// on port 443, carry no embedded credentials, and resolve to a public IP address.

Maximum string length: 2048
description
string
Maximum string length: 255

Response

Created subscription including its secret

data
object
required
meta
object
required