Skip to main content
Deliverable events notify you when the final signed document, known as the deliverable, is generated or if its generation fails. This page explains each deliverable event type, when it occurs, and the additional data included in the event payload.

​
deliverable.generated

The deliverable.generated event is triggered when a deliverable is successfully generated and ready for download. The event data includes a url property that provides a pre-signed, short-lived direct download link to the deliverable. This URL is valid for immediate use and will expire shortly after it is issued. If the URL has expired, you can obtain a new download link by sending a Retrieve Deliverable request.
JSON
{
    "id": "evt_1a2b3c4d5e6f7g8h9i0j",
    "type": "deliverable.generated",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "del_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "deliverable",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "url": "https://vault.signatureapi.com/envelopes/e387553d-cbb7-4924-abd8-b2d89699e9b5/deliverables/del_00ZeZjRaXCgT30n1eBx53N/sealed.pdf?Signature=..."
    }
}

​
deliverable.failed

The deliverable.failed event is triggered when the generation of a deliverable fails, resulting in a status of failed. The event data includes a detail property with information about the failure.
JSON
{
    "id": "evt_2b3c4d5e6f7g8h9i0j1k",
    "type": "deliverable.failed",
    "timestamp": "2025-12-31T23:59:59.999Z",
    "data": {
        "object_id": "del_00ZeZjRaXCgT30n1eBx53N",
        "object_type": "deliverable",
        "envelope_id": "e387553d-cbb7-4924-abd8-b2d89699e9b5",
        "envelope_metadata": {
            "deal_id": "50055",
            "deal_owner": "Jane C."
        },
        "detail": "The audit log could not be generated due to a system error."
    }
}