Skip to main content
Webhook

​
Definition

A Webhook is a mechanism that allows you to receive real-time notifications about events that occur for an envelope. You can use webhooks to receive notifications about envelope status changes.

​
Schema

​
id
string

Unique identifier of the webhook

​
event
enum<string>

Event of the webhook

Available options:
ENVELOPE_EXPIRED,
ENVELOPE_DECLINED,
ENVELOPE_VOIDED,
ENVELOPE_COMPLETED,
ENVELOPE_AUDIT_TRAIL
​
target
string

Target URL of the webhook