{"items":[{"type":"separator","label":"Get Started"},{"type":"link","fsPath":"get-started.md","metadata":{"type":"markdown"},"label":"Send Your First Envelope","link":"/get-started","routeSlug":"/get-started","icon":"bolt"},{"type":"group","fsPath":"concepts.md","metadata":{"type":"markdown"},"label":"Signable Concepts","link":"/concepts","routeSlug":"/concepts","items":[{"type":"link","fsPath":"tags.md","metadata":{"type":"markdown"},"label":"Use Signable Tags","link":"/tags","routeSlug":"/tags","icon":"tag"},{"type":"link","fsPath":"envelope-status.md","metadata":{"type":"markdown"},"label":"Envelope Status Values","link":"/envelope-status","routeSlug":"/envelope-status","icon":"list-check"}],"icon":"lightbulb"},{"type":"link","fsPath":"terminology.md","metadata":{"type":"markdown"},"label":"Signable Terminology","link":"/terminology","routeSlug":"/terminology","icon":"book"},{"type":"link","fsPath":"testing.md","metadata":{"type":"markdown"},"label":"Test the Signable API","link":"/testing","routeSlug":"/testing","icon":"magnifying-glass"},{"type":"separator","label":"Guides"},{"type":"group","fsPath":"guides/send-envelope/send-an-envelope.md","metadata":{"type":"markdown"},"label":"How to Send an Envelope","link":"/guides/send-envelope/send-an-envelope","routeSlug":"/guides/send-envelope/send-an-envelope","items":[{"type":"link","fsPath":"guides/send-envelope/send-envelope-uploaded-document.md","metadata":{"type":"markdown"},"label":"Send an Envelope with an Uploaded Document","link":"/guides/send-envelope/send-envelope-uploaded-document","routeSlug":"/guides/send-envelope/send-envelope-uploaded-document"},{"type":"group","fsPath":"guides/send-envelope/send-envelope-template.md","metadata":{"type":"markdown"},"label":"Send an Envelope Using a Template","link":"/guides/send-envelope/send-envelope-template","routeSlug":"/guides/send-envelope/send-envelope-template","items":[{"type":"link","fsPath":"guides/send-envelope/send-envelope-multiple-template.md","metadata":{"type":"markdown"},"label":"Send an Envelope Using Multiple Templates","link":"/guides/send-envelope/send-envelope-multiple-template","routeSlug":"/guides/send-envelope/send-envelope-multiple-template"}]}]},{"type":"group","fsPath":"guides/embedded-signing/embedded.md","metadata":{"type":"markdown"},"label":"Embedded Signing","link":"/guides/embedded-signing/embedded","routeSlug":"/guides/embedded-signing/embedded","items":[{"type":"link","fsPath":"guides/embedded-signing/enable-embedded-signing.md","metadata":{"type":"markdown"},"label":"Enable Embedded Signing","link":"/guides/embedded-signing/enable-embedded-signing","routeSlug":"/guides/embedded-signing/enable-embedded-signing"},{"type":"link","fsPath":"guides/embedded-signing/send-envelope-embedded-signing.md","metadata":{"type":"markdown"},"label":"Send an Envelope with Embedded Signing","link":"/guides/embedded-signing/send-envelope-embedded-signing","routeSlug":"/guides/embedded-signing/send-envelope-embedded-signing"}]},{"type":"separator","label":"Authentication"},{"type":"link","fsPath":"authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/authentication","routeSlug":"/authentication","icon":"key"},{"type":"separator","label":"Webhooks"},{"type":"link","fsPath":"webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/webhooks","routeSlug":"/webhooks","icon":"webhook"},{"type":"separator","label":"Partners"},{"type":"group","fsPath":"partners/partner-program.md","metadata":{"type":"markdown"},"label":"Partner Program","link":"/partners/partner-program","routeSlug":"/partners/partner-program","items":[{"type":"link","fsPath":"partners/getting-started.md","metadata":{"type":"markdown"},"label":"Getting Started as a Reseller","link":"/partners/getting-started","routeSlug":"/partners/getting-started"},{"type":"link","fsPath":"partners/reseller-model.md","metadata":{"type":"markdown"},"label":"Reseller Model","link":"/partners/reseller-model","routeSlug":"/partners/reseller-model"},{"type":"link","fsPath":"partners/reseller-authentication.md","metadata":{"type":"markdown"},"label":"Authentication for Resellers","link":"/partners/reseller-authentication","routeSlug":"/partners/reseller-authentication"},{"type":"link","fsPath":"partners/reseller-faq.md","metadata":{"type":"markdown"},"label":"Reseller FAQ","link":"/partners/reseller-faq","routeSlug":"/partners/reseller-faq"}],"icon":"handshake"},{"type":"separator","label":"API Reference"},{"type":"link","label":"Signable API","link":"/openapi","routeSlug":"/openapi"},{"type":"group","label":"Partners","link":"/openapi/partners","routeSlug":"/openapi/partners","items":[{"label":"List sub-accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/getcompanies","routeSlug":"/openapi/partners/getcompanies","metadata":{"seo":{"title":"List sub-accounts","description":"Returns a paginated list of sub-accounts associated with the Partner account."}},"httpPath":"/companies"},{"label":"Create a sub-account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/createcompany","routeSlug":"/openapi/partners/createcompany","metadata":{"seo":{"title":"Create a sub-account","description":"Creates a new sub-account under the Partner account."}},"httpPath":"/companies"},{"label":"Get a sub-account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/getcompany","routeSlug":"/openapi/partners/getcompany","metadata":{"seo":{"title":"Get a sub-account","description":"Returns details about a specific sub-account associated with the Partner account."}},"httpPath":"/companies/{company_id}"},{"label":"Update a sub-account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/updatecompany","routeSlug":"/openapi/partners/updatecompany","metadata":{"seo":{"title":"Update a sub-account","description":"Updates details of a specific sub-account associated with the authenticated Partner account."}},"httpPath":"/companies/{company_id}"},{"label":"Delete a sub-account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/deletecompany","routeSlug":"/openapi/partners/deletecompany","metadata":{"seo":{"title":"Delete a sub-account","description":"Permanently deletes a sub-account (company) from the Partner account."}},"httpPath":"/companies/{company_id}"},{"label":"View usage for all sub-accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/partners/getcompaniesusage","routeSlug":"/openapi/partners/getcompaniesusage","metadata":{"seo":{"title":"View usage for all sub-accounts","description":"Retrieves usage data for all sub-accounts under a Partner account, including current and previous period comparisons. This endpoint is only available to Signable Partners."}},"httpPath":"/usage"}]},{"type":"group","label":"Envelopes","link":"/openapi/envelopes","routeSlug":"/openapi/envelopes","items":[{"label":"List envelopes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/listenvelopes","routeSlug":"/openapi/envelopes/listenvelopes","metadata":{"seo":{"title":"List envelopes","description":"Returns a paginated list of envelopes. You can filter by envelope status or search by title using optional query parameters."}},"httpPath":"/envelopes"},{"label":"Send an envelope","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/sendenvelope","routeSlug":"/openapi/envelopes/sendenvelope","metadata":{"seo":{"title":"Send an envelope","description":"Creates and queues a new envelope for sending, using one of the following methods for attaching documents:"}},"httpPath":"/envelopes"},{"label":"Get envelope details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/getenvelope","routeSlug":"/openapi/envelopes/getenvelope","metadata":{"seo":{"title":"Get envelope details","description":"Returns the full details of a specific envelope, including document data, party information, field data, and envelope history."}},"httpPath":"/envelopes/{envelope_fingerprint}"},{"label":"Delete an envelope","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/deleteenvelope","routeSlug":"/openapi/envelopes/deleteenvelope","metadata":{"seo":{"title":"Delete an envelope","description":"Deletes an envelope. Only available for envelopes in draft, signed, expired or cancelled status. No notification email is sent to signers when an envelope is deleted."}},"httpPath":"/envelopes/{envelope_fingerprint}"},{"label":"Send envelope reminder","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/remindenvelope","routeSlug":"/openapi/envelopes/remindenvelope","metadata":{"seo":{"title":"Send envelope reminder","description":"Sends a reminder email to all outstanding signing parties for the specified envelope. If automatic reminders are enabled, this also resets the countdown timer for the next scheduled reminder."}},"httpPath":"/envelopes/{envelope_fingerprint}/remind"},{"label":"Cancel an envelope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/cancelenvelope","routeSlug":"/openapi/envelopes/cancelenvelope","metadata":{"seo":{"title":"Cancel an envelope","description":"Cancels a sent envelope. A cancellation email will be sent to all signing parties, and the envelope will no longer be available for signing."}},"httpPath":"/envelopes/{envelope_fingerprint}/cancel"},{"label":"Expire an envelope","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/expireenvelope","routeSlug":"/openapi/envelopes/expireenvelope","metadata":{"seo":{"title":"Expire an envelope","description":"Expires a sent envelope, preventing any further signing interaction. No notification email is sent to signers when an envelope expires."}},"httpPath":"/envelopes/{envelope_fingerprint}/expire"},{"label":"Update an envelope party","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/envelopes/updateenvelopeparty","routeSlug":"/openapi/envelopes/updateenvelopeparty","metadata":{"seo":{"title":"Update an envelope party","description":"Updates an envelope party email address and/or title."}},"httpPath":"/envelopes/{envelope_fingerprint}/parties/{party_id}"}]},{"type":"group","label":"Templates","link":"/openapi/templates","routeSlug":"/openapi/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/templates/listtemplates","routeSlug":"/openapi/templates/listtemplates","metadata":{"seo":{"title":"List templates","description":"Retrieves a paginated list of all templates available in your account."}},"httpPath":"/templates"},{"label":"Get template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/templates/gettemplate","routeSlug":"/openapi/templates/gettemplate","metadata":{"seo":{"title":"Get template","description":"Retrieves metadata and configuration for a single template."}},"httpPath":"/templates/{template_fingerprint}"},{"label":"Delete a template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/templates/deletetemplate","routeSlug":"/openapi/templates/deletetemplate","metadata":{"seo":{"title":"Delete a template","description":"Deletes a template by its fingerprint."}},"httpPath":"/templates/{template_fingerprint}"}]},{"type":"group","label":"Contacts","link":"/openapi/contacts","routeSlug":"/openapi/contacts","items":[{"label":"List contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/listcontacts","routeSlug":"/openapi/contacts/listcontacts","metadata":{"seo":{"title":"List contacts","description":"Retrieves a paginated list of all contacts. Use offset and limit query parameters to control pagination."}},"httpPath":"/contacts"},{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/createcontact","routeSlug":"/openapi/contacts/createcontact","metadata":{"seo":{"title":"Create a contact","description":"Adds a new contact to your contact list. Invalid contact_email values are currently returned as the same error used for a missing email address."}},"httpPath":"/contacts"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getcontact","routeSlug":"/openapi/contacts/getcontact","metadata":{"seo":{"title":"Get a contact","description":"Retrieves details of a single contact by contact_id."}},"httpPath":"/contacts/{contact_id}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/updatecontact","routeSlug":"/openapi/contacts/updatecontact","metadata":{"seo":{"title":"Update a contact","description":"Updates a contact's name or email address. The API supports partial updates: send contact_name, contact_email, or both."}},"httpPath":"/contacts/{contact_id}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/deletecontact","routeSlug":"/openapi/contacts/deletecontact","metadata":{"seo":{"title":"Delete a contact","description":"Deletes a contact by their contact_id."}},"httpPath":"/contacts/{contact_id}"},{"label":"List envelopes for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/listcontactenvelopes","routeSlug":"/openapi/contacts/listcontactenvelopes","metadata":{"seo":{"title":"List envelopes for a contact","description":"Returns a paginated list of all envelopes that the contact is a recipient of. Each envelope includes basic metadata such as its current status, timestamps, and optional signed PDF link."}},"httpPath":"/contacts/{contact_id}/envelopes"}]},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listusers","routeSlug":"/openapi/users/listusers","metadata":{"seo":{"title":"List users","description":"Retrieves a paginated list of all users in your account. You can control pagination using the offset and limit query parameters."}},"httpPath":"/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/createuser","routeSlug":"/openapi/users/createuser","metadata":{"seo":{"title":"Create a user","description":"Adds a new user to your account. You must provide the user’s name, email address, and their role ID."}},"httpPath":"/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/getuser","routeSlug":"/openapi/users/getuser","metadata":{"seo":{"title":"Get a user","description":"Retrieves the details of a single user by their unique user_id. The response includes the user's name, email, role, and timestamps."}},"httpPath":"/users/{user_id}"},{"label":"Update a user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/updateuser","routeSlug":"/openapi/users/updateuser","metadata":{"seo":{"title":"Update a user","description":"Updates a user by user_id."}},"httpPath":"/users/{user_id}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/deleteuser","routeSlug":"/openapi/users/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"Removes a user from your account using their user_id. The response confirms the deletion and includes the user's basic details."}},"httpPath":"/users/{user_id}"}]},{"type":"group","label":"Branding","link":"/openapi/branding","routeSlug":"/openapi/branding","items":[{"label":"Get branding settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/branding/getbranding","routeSlug":"/openapi/branding/getbranding","metadata":{"seo":{"title":"Get branding settings","description":"Returns your company's current branding settings, including any uploaded logo and primary colour. These settings control how Signable emails and signing pages appear to your signers."}},"httpPath":"/branding"},{"label":"Update branding settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/branding/updatebranding","routeSlug":"/openapi/branding/updatebranding","metadata":{"seo":{"title":"Update branding settings","description":"Update your account's branding settings. This includes the logo and the primary colour used on emails and signing pages."}},"httpPath":"/branding"},{"label":"List branding emails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/branding/getbrandingemails","routeSlug":"/openapi/branding/getbrandingemails","metadata":{"seo":{"title":"List branding emails","description":"List branding emails"}},"httpPath":"/branding/emails"},{"label":"Get a branding email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/branding/getsinglebrandingemail","routeSlug":"/openapi/branding/getsinglebrandingemail","metadata":{"seo":{"title":"Get a branding email","description":"Retrieves a single branding email template"}},"httpPath":"/branding/emails/{branding_email_type}"},{"label":"Update a branding email","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/branding/updatebrandingemail","routeSlug":"/openapi/branding/updatebrandingemail","metadata":{"seo":{"title":"Update a branding email","description":"You can include variables like {company name} and {contract title} in your email body to personalise content. See the full list of supported variables →"}},"httpPath":"/branding/emails/{branding_email_type}"}]},{"type":"group","label":"Settings","link":"/openapi/settings","routeSlug":"/openapi/settings","items":[{"label":"Get company settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/settings/listsettings","routeSlug":"/openapi/settings/listsettings","metadata":{"seo":{"title":"Get company settings","description":"Your Signable account settings control how documents are delivered, signed, and managed across your team.This section of the API lets you retrieve and update your company's signing preferences, email notification rules, signature formats, and more—giving you full control over how your documents behave.Settings can be accessed via the API or in the Signable web app under Company Settings > Preferences."}},"httpPath":"/settings"},{"label":"Update company settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/settings/updatesettings","routeSlug":"/openapi/settings/updatesettings","metadata":{"seo":{"title":"Update company settings","description":"Update your company's settings. If no valid update can be applied, the API returns the current settings without making changes."}},"httpPath":"/settings"}]},{"type":"group","label":"Webhooks","link":"/openapi/webhooks","routeSlug":"/openapi/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/listwebhooks","routeSlug":"/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Retrieves a paginated list of all webhooks currently registered to receive event notifications. Supports offset and limit for pagination. Webhooks include metadata about creation, update, and suspension state."}},"httpPath":"/webhooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/createwebhook","routeSlug":"/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Registers a new webhook that will be triggered when a specific event occurs. You must provide a valid webhook_url and a supported webhook_type. The created webhook will immediately be eligible to receive matching notifications."}},"httpPath":"/webhooks"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/getwebhook","routeSlug":"/openapi/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Retrieves details of a specific webhook by its unique webhook_id. The response includes the current status and metadata of the webhook."}},"httpPath":"/webhooks/{webhook_id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/updatewebhook","routeSlug":"/openapi/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Updates the webhook identified by webhook_id. The request body may include webhook_url, webhook_type, or both."}},"httpPath":"/webhooks/{webhook_id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/deletewebhook","routeSlug":"/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Deletes the webhook identified by webhook_id. Once removed, the webhook will no longer receive event notifications."}},"httpPath":"/webhooks/{webhook_id}"}]},{"type":"group","label":"Webhook Events","link":"/openapi/webhook-events","routeSlug":"/openapi/webhook-events","items":[{"label":"Envelope sent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivesendenvelopewebhook","routeSlug":"/openapi/webhook-events/receivesendenvelopewebhook","metadata":{"seo":{"title":"Envelope sent","description":"This webhook is triggered after an envelope has been successfully processed and sent. It delivers information about the envelope, the recipient, any additional metadata, and a download URL."}},"httpPath":"send-envelope"},{"label":"Envelope signed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivesignedenvelopewebhook","routeSlug":"/openapi/webhook-events/receivesignedenvelopewebhook","metadata":{"seo":{"title":"Envelope signed","description":"This webhook is triggered when a recipient completes signing an envelope. It includes detailed information about the envelope, signer, documents, custom fields, and signature fingerprint."}},"httpPath":"signed-envelope"},{"label":"Envelope cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivecancelledenvelopewebhook","routeSlug":"/openapi/webhook-events/receivecancelledenvelopewebhook","metadata":{"seo":{"title":"Envelope cancelled","description":"This webhook is triggered when an envelope is cancelled before completion. It includes the envelope fingerprint, user details, and any metadata associated with the envelope."}},"httpPath":"cancelled-envelope"},{"label":"Envelope expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveexpiredenvelopewebhook","routeSlug":"/openapi/webhook-events/receiveexpiredenvelopewebhook","metadata":{"seo":{"title":"Envelope expired","description":"This webhook is triggered when an envelope expires. It includes basic information about the envelope and the recipient."}},"httpPath":"expired-envelope"},{"label":"Envelope signed and complete","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivesignedenvelopecompletewebhook","routeSlug":"/openapi/webhook-events/receivesignedenvelopecompletewebhook","metadata":{"seo":{"title":"Envelope signed and complete","description":"This webhook is triggered when all required parties have completed signing an envelope. It includes the envelope fingerprint, documents, any captured field data, and a download link."}},"httpPath":"signed-envelope-complete"},{"label":"Envelope rejected","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiverejectedenvelopewebhook","routeSlug":"/openapi/webhook-events/receiverejectedenvelopewebhook","metadata":{"seo":{"title":"Envelope rejected","description":"This webhook is triggered when a recipient rejects an envelope. It includes details about the envelope, the rejecting contact, and relevant metadata."}},"httpPath":"rejected-envelope"},{"label":"Envelope opened","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveopenedenvelopewebhook","routeSlug":"/openapi/webhook-events/receiveopenedenvelopewebhook","metadata":{"seo":{"title":"Envelope opened","description":"This webhook is triggered when a recipient opens an envelope. It includes basic information about the envelope, the recipient, and associated documents."}},"httpPath":"opened-envelope"},{"label":"Envelope email bounced","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivebouncedenvelopewebhook","routeSlug":"/openapi/webhook-events/receivebouncedenvelopewebhook","metadata":{"seo":{"title":"Envelope email bounced","description":"Triggered when an email to a signer fails to deliver."}},"httpPath":"bounced-envelope"},{"label":"Envelope send failed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receivesendenvelopefailedwebhook","routeSlug":"/openapi/webhook-events/receivesendenvelopefailedwebhook","metadata":{"seo":{"title":"Envelope send failed","description":"This webhook is triggered when an envelope fails to send."}},"httpPath":"send-envelope-failed"},{"label":"Widget completed (Awaiting verification)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveverifyenvelopewidgetwebhook","routeSlug":"/openapi/webhook-events/receiveverifyenvelopewidgetwebhook","metadata":{"seo":{"title":"Widget completed (Awaiting verification)","description":"This webhook is triggered when a recipient signs an envelope via the widget, but has not yet verified. It includes contact and document details."}},"httpPath":"verify-envelope-widget"},{"label":"Widget signature verified","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveverifiedenvelopewidgetwebhook","routeSlug":"/openapi/webhook-events/receiveverifiedenvelopewidgetwebhook","metadata":{"seo":{"title":"Widget signature verified","description":"This webhook is triggered when a recipient verifies their signed envelope through the verification email. It includes details about the contact, documents, and verification."}},"httpPath":"verified-envelope-widget"},{"label":"Template added","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveaddtemplatewebhook","routeSlug":"/openapi/webhook-events/receiveaddtemplatewebhook","metadata":{"seo":{"title":"Template added","description":"This webhook is triggered when a new template is added to the account. It includes basic information about the template, including its title and fingerprint."}},"httpPath":"add-template"},{"label":"Contact added","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveaddcontactwebhook","routeSlug":"/openapi/webhook-events/receiveaddcontactwebhook","metadata":{"seo":{"title":"Contact added","description":"This webhook is triggered when a new contact is added to the account. It includes basic information about the contact and the company that added them."}},"httpPath":"add-contact"},{"label":"User added","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/receiveadduserwebhook","routeSlug":"/openapi/webhook-events/receiveadduserwebhook","metadata":{"seo":{"title":"User added","description":"This webhook is triggered when a new user is added to the account. It includes identifying information about the user and their assigned role."}},"httpPath":"add-user"}]},{"type":"separator","label":"Errors"},{"type":"group","fsPath":"errors/general-errors.md","metadata":{"type":"markdown"},"label":"Error Codes","link":"/errors/general-errors","routeSlug":"/errors/general-errors","items":[{"type":"link","fsPath":"errors/partners-errors.md","metadata":{"type":"markdown"},"label":"Partners","link":"/errors/partners-errors","routeSlug":"/errors/partners-errors"},{"type":"link","fsPath":"errors/envelope-errors.md","metadata":{"type":"markdown"},"label":"Envelopes","link":"/errors/envelope-errors","routeSlug":"/errors/envelope-errors"},{"type":"link","fsPath":"errors/template-errors.md","metadata":{"type":"markdown"},"label":"Templates","link":"/errors/template-errors","routeSlug":"/errors/template-errors"},{"type":"link","fsPath":"errors/contact-errors.md","metadata":{"type":"markdown"},"label":"Contacts","link":"/errors/contact-errors","routeSlug":"/errors/contact-errors"},{"type":"link","fsPath":"errors/user-errors.md","metadata":{"type":"markdown"},"label":"Users","link":"/errors/user-errors","routeSlug":"/errors/user-errors"},{"type":"link","fsPath":"errors/branding-errors.md","metadata":{"type":"markdown"},"label":"Branding","link":"/errors/branding-errors","routeSlug":"/errors/branding-errors"},{"type":"link","fsPath":"errors/webhook-errors.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/errors/webhook-errors","routeSlug":"/errors/webhook-errors"},{"type":"link","fsPath":"errors/settings-errors.md","metadata":{"type":"markdown"},"label":"Settings","link":"/errors/settings-errors","routeSlug":"/errors/settings-errors"}]}]}