Overview
The flow works in three steps:- SignatureAPI sends an
envelope.completedwebhook event to your endpoint. - Your server retrieves the full envelope (including captures) using the API.
- Your server stores the relevant data in your database.
Step 1: Set Up a Webhook Endpoint
Register a webhook endpoint in the Dashboard and subscribe to theenvelope.completed event. See Set Up Webhooks for detailed instructions.
Step 2: Create an Envelope with Captures
When creating the envelope, usecapture_as on interactive places to store values entered by the signer. Also use metadata to attach your own identifiers for matching the envelope back to your records.
Step 3: Handle the Webhook Event
When the envelope completes, SignatureAPI sends anenvelope.completed event to your endpoint:
envelope_metadata property reflects the metadata you attached when creating the envelope. You can use these values to match the event to your internal records without making an additional API call.
Step 4: Retrieve the Envelope
If you need data beyond what the webhook event provides (such as captured input from the signer), use theenvelope_id from the event to fetch the full envelope.
captures object contains any values the signer entered in interactive places that had capture_as defined.
Step 5: Store the Data
With the envelope details and captures in hand, persist the data to your database. Here is a conceptual example:Always verify the webhook signature before processing events in production.
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 more about captures and which place types support them.
- Set up webhooks with signature verification and retry handling.
- Use topics to route events from specific envelopes to different webhook endpoints.
- Download signed documents after the envelope completes.