Events

Every delivery has the same envelope. event is one of the names below and data is that event’s payload.

{
  "event": "SESSION_COMPLETED",
  "timestamp": "2026-09-17T01:15:02.318Z",
  "data": { ... }
}

string

required

The event name.

string

required

When the event was raised, ISO 8601 in UTC.

object

required

Event-specific payload, documented per event below.

boolean

true on a sample sent with Send test event. Absent on real events.

Events about one package are recorded in the order they happened, so an endpoint receives 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:

object

required

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.

The same schemas are published in the OpenAPI spec as 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 reads IN_PROGRESS when this arrives.

string

required

string

required

integer

required

Number of recipients who must act on the package.

integer

required

Number of sessions invited immediately. Lower than signerCount when recipients sign in order.

{
  "event": "PACKAGE_SENT",
  "timestamp": "2026-09-17T01:12:50.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "signerCount": 2,
    "sessionsSent": 1,
    "metadata": { "employee_id": "E-1042" }
  }
}

PACKAGE_COMPLETED

Raised when the last recipient finishes and the package becomes COMPLETED.

string

required

string

required

string

required

ISO 8601 timestamp.

{
  "event": "PACKAGE_COMPLETED",
  "timestamp": "2026-09-17T03:40:11.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "completedAt": "2026-09-17T03:40:10.884Z",
    "metadata": { "employee_id": "E-1042" }
  }
}

PACKAGE_DECLINED

Raised when a recipient’s decline ends the package as DECLINED. A SESSION_CANCELLED event follows for every other recipient whose session was open.

string

required

string

required

string | null

required

The reason the recipient gave, if any.

{
  "event": "PACKAGE_DECLINED",
  "timestamp": "2026-09-17T02:05:30.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "reason": "Start date is wrong",
    "metadata": { "employee_id": "E-1042" }
  }
}

PACKAGE_VOIDED

Raised when a package is voided by a member or through the API. A SESSION_CANCELLED event follows for every recipient whose session was open.

string

required

string

required

string

required

Email address of the member who voided it, or system.

{
  "event": "PACKAGE_VOIDED",
  "timestamp": "2026-09-17T02:30:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "voidedBy": "ops@example.com",
    "metadata": { "employee_id": "E-1042" }
  }
}

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. A SESSION_CANCELLED event follows for every recipient whose session was open.

string

required

string

required

{
  "event": "PACKAGE_EXPIRED",
  "timestamp": "2026-10-17T00:00:05.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "metadata": { "employee_id": "E-1042" }
  }
}

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.

string

required

string

required

string

required

Email address of the member who put it on hold, or system.

{
  "event": "PACKAGE_ON_HOLD",
  "timestamp": "2026-09-17T02:10:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "heldBy": "ops@example.com",
    "metadata": { "employee_id": "E-1042" }
  }
}

PACKAGE_RESUMED

Raised when a package on hold goes back out for signing.

string

required

string

required

string

required

Email address of the member who resumed it, or system.

string | null

required

The new expiry, ISO 8601, pushed back by the time the package spent on hold. Null when the package never expires.

{
  "event": "PACKAGE_RESUMED",
  "timestamp": "2026-09-18T09:00:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "resumedBy": "ops@example.com",
    "expiresAt": "2026-10-18T06:50:00.000Z",
    "metadata": { "employee_id": "E-1042" }
  }
}

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.

string

required

string

required

string

required

When the package will send, ISO 8601.

{
  "event": "PACKAGE_SCHEDULED",
  "timestamp": "2026-09-17T01:00:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "scheduledAt": "2026-09-20T20:00:00.000Z",
    "metadata": { "employee_id": "E-1042" }
  }
}

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. A SESSION_CANCELLED event follows for every recipient whose session was open. The package is gone by the time this arrives, so GET /api/v1/packages/{packageId} returns 404.

string

required

string

required

string

required

Email address of the member who deleted it.

{
  "event": "PACKAGE_DELETED",
  "timestamp": "2026-11-02T04:12:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "packageTitle": "Employment agreement: Ana Reid",
    "deletedBy": "ops@example.com",
    "metadata": { "employee_id": "E-1042" }
  }
}

Session events

All session events share these fields:

string

required

string

required

Matches recipientSessions[].id on GET /api/v1/packages/{packageId}.

string | null

required

string | null

required

SESSION_SENT

Raised when a recipient’s invitation is sent. In a sequential package this happens when it becomes their turn.

string

required

{
  "event": "SESSION_SENT",
  "timestamp": "2026-09-17T01:12:50.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "packageTitle": "Employment agreement: Ana Reid",
    "metadata": { "employee_id": "E-1042" }
  }
}

SESSION_OPENED

Raised when the recipient opens their session. Carries the shared fields only.

{
  "event": "SESSION_OPENED",
  "timestamp": "2026-09-17T01:20:14.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "metadata": { "employee_id": "E-1042" }
  }
}

SESSION_COMPLETED

Raised when the recipient finishes their session.

string

required

{
  "event": "SESSION_COMPLETED",
  "timestamp": "2026-09-17T01:26:02.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "packageTitle": "Employment agreement: Ana Reid",
    "metadata": { "employee_id": "E-1042" }
  }
}

SESSION_DECLINED

Raised when the recipient declines to sign. A PACKAGE_DECLINED event follows when the decline ends the package.

string

required

string | null

required

The reason the recipient gave, if any.

{
  "event": "SESSION_DECLINED",
  "timestamp": "2026-09-17T02:05:29.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "packageTitle": "Employment agreement: Ana Reid",
    "reason": "Start date is wrong",
    "metadata": { "employee_id": "E-1042" }
  }
}

SESSION_REMINDED

Raised each time a recipient is sent a reminder, whether a member sent it or the package’s reminder schedule did.

string

required

string

required

manual when a member sent the reminder, automatic when the reminder schedule did.

{
  "event": "SESSION_REMINDED",
  "timestamp": "2026-09-20T01:12:50.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "packageTitle": "Employment agreement: Ana Reid",
    "trigger": "automatic",
    "metadata": { "employee_id": "E-1042" }
  }
}

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 its sessionId no longer appears on the package.

string

required

{
  "event": "SESSION_CANCELLED",
  "timestamp": "2026-09-17T02:30:00.000Z",
  "data": {
    "packageId": "pkg_9f3c2e",
    "sessionId": "ses_71ab",
    "recipientName": "Ana Reid",
    "recipientEmail": "ana@example.com",
    "packageTitle": "Employment agreement: Ana Reid",
    "metadata": { "employee_id": "E-1042" }
  }
}

Webhooks

Resources

Package events

PACKAGE_SENT

PACKAGE_COMPLETED

PACKAGE_DECLINED

PACKAGE_VOIDED

PACKAGE_EXPIRED

PACKAGE_ON_HOLD

PACKAGE_RESUMED

PACKAGE_SCHEDULED

PACKAGE_DELETED

Session events

SESSION_SENT

SESSION_OPENED

SESSION_COMPLETED

SESSION_DECLINED

SESSION_REMINDED

SESSION_CANCELLED

​Package events

​PACKAGE_SENT

​PACKAGE_COMPLETED

​PACKAGE_DECLINED

​PACKAGE_VOIDED

​PACKAGE_EXPIRED

​PACKAGE_ON_HOLD

​PACKAGE_RESUMED

​PACKAGE_SCHEDULED

​PACKAGE_DELETED

​Session events

​SESSION_SENT

​SESSION_OPENED

​SESSION_COMPLETED

​SESSION_DECLINED

​SESSION_REMINDED

​SESSION_CANCELLED

Package events

PACKAGE_SENT

PACKAGE_COMPLETED

PACKAGE_DECLINED

PACKAGE_VOIDED

PACKAGE_EXPIRED

PACKAGE_ON_HOLD

PACKAGE_RESUMED

PACKAGE_SCHEDULED

PACKAGE_DELETED

Session events

SESSION_SENT

SESSION_OPENED

SESSION_COMPLETED

SESSION_DECLINED

SESSION_REMINDED

SESSION_CANCELLED