Envelope Forms
This document contains an overview of envelope forms, including how they work and what you can configure via the API.
Last updated
Was this helpful?
This document contains an overview of envelope forms, including how they work and what you can configure via the API.
Envelope forms let you create envelopes from a shared link. Each form is based on a template with predefined fields and roles.
When users open an envelope form link, they see a page where they can complete the required fields. Each submission creates a new envelope.
Use envelope forms to configure:
predefined field values
assigned roles
metadata
callbacks
Create envelope forms only via Swagger UI.
Add metadata to apply the same values to every envelope created from a form. Metadata is separate from the document content.
Use metadata to:
store external or business-specific references
filter envelopes in the mailbox
search for envelopes later
Add callbacks to send form events to your system. When a form creates an envelope, the callback can send:
envelope ID
metadata
additional form-related data
Use callbacks to automate follow-up actions in external systems. Callbacks are removed automatically when you delete the form. For single-use forms, callbacks are also removed after the first submission.
Last updated
Was this helpful?
Was this helpful?