Deliverable events

Receive notifications when signed documents are generated and ready for download.

Deliverable events notify you when SignatureAPI generates the final signed document (the deliverable), or when generation fails. This page explains each event type, when it fires, and the additional data included in the payload.

deliverable.generated

Fires when a deliverable is successfully generated and ready for download.

The data.url property contains a pre-signed download link. This URL expires after 1 hour. If it has expired, call the Retrieve Deliverable endpoint to get a fresh link.

Example payload

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."
        },
        "deliverable_type": "standard",
        "deliverable_name": null,
        "included_documents": ["contract", "addendum"],
        "url": "https://vault.signatureapi.com/envelopes/e387553d-cbb7-4924-abd8-b2d89699e9b5/deliverables/del_00ZeZjRaXCgT30n1eBx53N/sealed.pdf?Signature=..."
    }
}

deliverable.failed

Fires when deliverable generation fails. The deliverable status is set to failed.

The data.detail property contains a human-readable explanation of the failure.

Deliverable failures are rare. SignatureAPI support is notified automatically when this event fires.

Example payload

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."
        },
        "deliverable_type": "standard",
        "deliverable_name": null,
        "included_documents": ["contract", "addendum"],
        "detail": "The audit log could not be generated due to a system error."
    }
}