Skip to main content
POST
Create webhook
Create a signed webhook endpoint for agreement activity and notification events. The signing secret is returned only in the create response.

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias.

Body

application/json
url
string<uri>
required

HTTPS endpoint that receives signed webhook POSTs.

eventTypes
enum<string>[]

Subscribable event types. On create, omitted, null, or empty eventTypes defaults to agreement.transitioned.

Available options:
agreement.transitioned,
agreement.notification.triggered
filters
object | null

On create, omitted, null, or an empty object all mean no filters, and the subscription receives every event it is subscribed to.

Response

Created webhook subscription.

data
object
required
Example:
meta
object
required