event is one of the names below and data is that event’s payload.
PACKAGE_SENT before that package’s SESSION_SENT events, and SESSION_DECLINED before PACKAGE_DECLINED before the SESSION_CANCELLED events that follow it. A retried delivery can still arrive after later ones, so order by timestamp when it matters.
Package events describe the package as a whole. Session events describe one recipient’s turn on a package. A recipient’s recipientName and recipientEmail are nullable because a session can exist before the recipient is known.
Every event also carries the package’s custom field values:
The package’s custom field values, keyed by the custom field’s key. Only fields with a value appear;
{} when none are set. Keys are managed under Settings > Custom fields.WebhookPayload_<EVENT> components, so you can generate types for your listener.
Package events
PACKAGE_SENT
Raised once when a package is sent and its signing sessions are created. The package already readsIN_PROGRESS when this arrives.
Number of sessions invited immediately. Lower than
signerCount when recipients sign in order.PACKAGE_COMPLETED
Raised when the last recipient finishes and the package becomesCOMPLETED.
PACKAGE_DECLINED
Raised when a recipient’s decline ends the package asDECLINED. A SESSION_CANCELLED event follows for every other recipient whose session was open.
PACKAGE_VOIDED
Raised when a package is voided by a member or through the API. ASESSION_CANCELLED event follows for every recipient whose session was open.
PACKAGE_EXPIRED
Raised when a sent package passes its expiry date unsigned. A package that expires before it was ever sent (a draft, or one still scheduled) raises nothing. ASESSION_CANCELLED event follows for every recipient whose session was open.
PACKAGE_ON_HOLD
Raised when a package out for signing is put on hold by a member or through the API. Recipients can’t sign until it is resumed.PACKAGE_RESUMED
Raised when a package on hold goes back out for signing.The new expiry, ISO 8601, pushed back by the time the package spent on hold. Null when the package never expires.
PACKAGE_SCHEDULED
Raised when a package is scheduled to send later, and again when a scheduled package is moved to a new time.PACKAGE_SENT follows when it sends.
PACKAGE_DELETED
Raised when a package that was scheduled, out for signing or on hold is deleted. Deleting a draft, or a package that had already completed, been declined or voided, raises nothing. The package is voided first, soPACKAGE_VOIDED and a SESSION_CANCELLED for every recipient whose session was open arrive before PACKAGE_DELETED. The package is gone by the time this arrives, so GET /api/v1/packages/{packageId} returns 404.
Session events
All session events share these fields:SESSION_SENT
Raised when a recipient’s invitation is sent. With ordered signing this happens when it becomes their turn.SESSION_OPENED
Raised when the recipient opens their session. Carries the shared fields only.SESSION_COMPLETED
Raised when the recipient finishes their session.SESSION_DECLINED
Raised when the recipient declines to sign. APACKAGE_DECLINED event follows when the decline ends the package.
SESSION_REMINDED
Raised each time a recipient is sent a reminder, whether a member sent it or the package’s reminder schedule did.SESSION_CANCELLED
Raised for each recipient whose session was open, meaning sent and not yet finished, when the package is declined by someone else, voided, expires or is deleted, or when a correction removes the recipient. A recipient whose turn had not come yet raises nothing. When a correction removes the recipient, their session is deleted, so itssessionId no longer appears on the package.

