Recipient events

Recipient events track key actions and status changes for recipients within an envelope, such as when a recipient is sent a request, completes their part, or is replaced. This page describes each event type, when it occurs, and the additional data you can expect in the event payload.

recipient.released

The recipient.released event is triggered when a recipient is ready to be sent a request. The recipient status changes to pending.

Example event payload

JSON

{
    "id": "evt_1a2b3c4d5e6f7g8h9i0j",
    "type": "recipient.released",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "recipient_type": "signer",
        "recipient_key": "client"
    }
}

recipient.sent

The recipient.sent event is triggered when a request is sent to a recipient.

Example event payload

JSON

{
    "id": "evt_2b3c4d5e6f7g8h9i0j1k",
    "type": "recipient.sent",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "recipient_type": "signer",
        "recipient_key": "client"
    }
}

recipient.completed

The recipient.completed event is triggered when a recipient has completed their part of the signing process. The recipient status changes to completed.

Example event payload

JSON

{
    "id": "evt_3c4d5e6f7g8h9i0j1k2l",
    "type": "recipient.completed",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client"
    }
}

recipient.rejected

The recipient.rejected event is triggered when a recipient rejects the envelope. If the recipient provided a reason for the rejection, it appears in the reason property. If no reason was given, the reason property is null.

Example event payload

JSON

{
    "id": "evt_4d5e6f7g8h9i0j1k2l3m",
    "type": "recipient.rejected",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "recipient_type": "signer",
        "recipient_key": "client",
        "reason": "The recipient declined to sign."
    }
}

recipient.soft_bounced

The recipient.soft_bounced event is triggered when a recipient’s email is temporarily undeliverable (for example, due to a full mailbox). The event data includes a detail property with more information.

Example event payload

JSON

{
    "id": "evt_5e6f7g8h9i0j1k2l3m4n",
    "type": "recipient.soft_bounced",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "recipient_type": "signer",
        "recipient_key": "client",
        "detail": "Mailbox full."
    }
}

recipient.hard_bounced

The recipient.hard_bounced event is triggered when a recipient’s email is permanently undeliverable (for example, due to an invalid email address). The event data includes a detail property with additional information about the bounce. You can view further details, such as SMTP responses, in the Dashboard.

If a signer’s email address hard bounces, you cannot send additional requests to that signer. To proceed, use the Replace Recipient endpoint to remove the affected signer from the envelope and add a new signer with a valid email address.

Example event payload

JSON

{
    "id": "evt_6f7g8h9i0j1k2l3m4n5o",
    "type": "recipient.hard_bounced",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "detail": "Email address does not exist."
    }
}

recipient.failed

The recipient.failed event is triggered when there is a failure related to a recipient. The event data includes a detail property with more information about the failure.

Example event payload

JSON

{
    "id": "evt_7g8h9i0j1k2l3m4n5o6p",
    "type": "recipient.failed",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "detail": "Failed to deliver to recipient."
    }
}

recipient.replaced

The recipient.replaced event is triggered when a recipient is replaced with a new one. The event data includes a new_recipient_id property, which provides the ID of the new recipient, and a new_recipient_name property, which provides the name of the new recipient.

Example event payload

JSON

{
    "id": "evt_8h9i0j1k2l3m4n5o6p7q",
    "type": "recipient.replaced",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "new_recipient_id": "re_11ZeZjRaXCgT30n1eBx53N",
        "new_recipient_name": "John Doe"
    }
}

recipient.resent

The recipient.resent event is triggered when a request is resent to a recipient.

Example event payload

JSON

{
    "id": "evt_9i0j1k2l3m4n5o6p7q8r",
    "type": "recipient.resent",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "re_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "recipient",
        "recipient_type": "signer",
        "recipient_key": "client",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        }
    }
}

Introduction

Reference

Explore

Envelopes

Recipients

Documents

Places

Deliverables

Ceremonies

Events

Uploads

Senders

recipient.released

recipient.sent

recipient.completed

recipient.rejected

recipient.soft_bounced

recipient.hard_bounced

recipient.failed

recipient.replaced

recipient.resent

Introduction

Reference

Explore

Envelopes

Recipients

Documents

Places

Deliverables

Ceremonies

Events

Uploads

Senders

​recipient.released

​recipient.sent

​recipient.completed

​recipient.rejected

​recipient.soft_bounced

​recipient.hard_bounced

​recipient.failed

​recipient.replaced

​recipient.resent

recipient.released

recipient.sent

recipient.completed

recipient.rejected

recipient.soft_bounced

recipient.hard_bounced

recipient.failed

recipient.replaced

recipient.resent