Deliverable events
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.
Example event payload
Example event payload
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.
Example event payload
Example event payload