Webhooks & Realtime Events
Receive automated HTTP push notifications when sessions complete, participants join, or documents are signed.
Instant Event Delivery
Eliminates constant polling. Your backend is instantly updated the moment an action occurs in the notary room.
HMAC SHA-256 Signatures
Every delivery includes an X-Eznotary-Signature header computed with your webhook saltKey.
Automatic Retry Policy
If your server does not respond with 2xx within 5s, EZNotary automatically retries up to 3 times with exponential backoff.
Verifying Webhook Signatures
Compute HMAC SHA-256 of the JSON request body using your webhook saltKey and compare with X-Eznotary-Signature.
Supported Webhook Events
Click an event to preview its payload schema:
Triggered when a notarization session is legally finalized and sealed by the notary.
Webhook Management Endpoints
Programmatically register and list webhook listeners
Register Webhook Endpoint
Subscribes your backend to specific events or all events using `*`. EZNotary generates a unique saltKey used to compute HMAC SHA-256 signatures for payload verification.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |
Request Body Parameters
Format: application/json| Field | Type | Required | Description |
|---|---|---|---|
url | string | Required | Your HTTPS webhook callback receiver endpoint. Example: https://api.yourcompany.com/webhooks/eznotary |
events | array of strings | Required | Array of event names to subscribe to, or `["*"]` for all events. Example: ["session.completed", "participant.joined", "kyc.verified"] Allowed:*session.createdsession.rescheduledsession.cancelledsession.completedparticipant.createdparticipant.joinedkyc.verifiedesign.signedesign.failed |
List Registered Webhooks
Returns all configured webhook URLs, active subscriptions, and salt keys for your tenant account.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| x-api-key | string | Required | Tenant API Key generated from the EZNotary B2B Developer Portal. |
| x-api-secret | string | Required | Tenant API Secret key paired with your API key. |