Webhook event notification

wbhk

WebhookEvent

When a subscribed event fires, eVault sends a POST to the url configured on the webhook. Every event uses the same payload shape; the event_type field identifies which event fired and the identifier fields present depend on the event (see the schema). Verify the ncino-evault-signature header to confirm the payload's authenticity.

Payload

Webhook event payload

Payload eVault sends as a POST to the configured webhook URL when a subscribed event fires. org_id and event_type are always present; the remaining identifier fields are included only when they are relevant to the event that fired. The body is signed — verify it using the ncino-evault-signature header (see the parameter on this callback).

org_id

string

required

The guid of the org the event belongs to. Always present.

event_type

string

enum

required

The event that fired, sent as the event_type field of the webhook payload. Values are the lowercased event keys. Subscribe to the events you want to receive via the events array when creating or editing a webhook configuration. A parent key (for example change_data, change_status, connectivity, delivery, inquiry, registration, transfer) can be subscribed to on its own to receive every event in that group.

enote_id

string

Included when the event relates to an eNote.

transaction_id

string

Included when the event relates to a MERS transaction.

audit_log_id

string

Included when the event has an associated audit log.

document_id

string

Included when the event relates to a document.

api_client_id

string

Included when the event relates to an API client.

org_api_client

string

Included when the event relates to an org API client.

user_id

string

Included when the event was initiated by a user.

additional_info

string | null

Optional event-specific context. Included only when the event carries extra detail.

Headers

ncino-evault-signature

string

Base64-encoded HMAC-SHA256 signature of the raw request body, computed with the signing key configured on the webhook. Use it to verify the payload came from eVault and was not modified in transit.

Response

200