Overview
The flow works in three steps:- SignatureAPI sends a
deliverable.generatedwebhook event when the signed document is ready. The event includes a pre-signed download URL. - Your server downloads the PDF from the URL in the event payload.
- Your server saves the file to your storage.
Step 1: Set Up a Webhook
Register a webhook endpoint in the Dashboard and subscribe to thedeliverable.generated event. See Set Up Webhooks for detailed instructions.
Step 2: Handle the Webhook Event
When the deliverable is generated, SignatureAPI sends an event with the download URL included directly in the payload:data:
url: A pre-signed download link for the signed PDF. This URL expires after 1 hour.deliverable_type: The type of deliverable (standardorsimple).deliverable_name: The custom name, if one was set when the deliverable was created.included_documents: The document keys included in this deliverable.envelope_metadata: The metadata you attached when creating the envelope.
Step 3: Download and Save the PDF
Use theurl from the event payload to download the PDF and save it to your storage. Here is a conceptual example:
The download URL in the event payload expires after 1 hour. If you need to download the file after the URL has expired, call the Retrieve Deliverable endpoint to get a fresh link.
Always verify the webhook signature before processing events in production.
Alternative: Retrieve the Deliverable via API
If you prefer to fetch deliverables without relying on the webhook URL, you can call the deliverables endpoint with the deliverable ID from the event:Try It
Try this example in Postman using your test API key to create a free, non-binding test envelope. Test envelopes won’t send emails, but you can review them in your dashboard.Keep Learning
- Learn about deliverable types, including standard and simple formats.
- Set up webhooks to automate your document processing pipeline.
- Store envelope data alongside the signed document for a complete record.
- Protect deliverables with a password.