Create webhook
Webhooks
Create webhook
Registers a signed webhook endpoint for subscribed agreement activity and notification events visible to the authenticated Shodai account. The signing secret is returned only in the create response.
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
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
HTTPS endpoint that receives signed webhook POSTs.
Subscribable event types. On create, omitted, null, or empty eventTypes defaults to agreement.transitioned.
Available options:
agreement.transitioned, agreement.notification.triggered On create, omitted, null, or an empty object all mean no filters, and the subscription receives every event it is subscribed to.