When you register a webhook URL, we will post the following list of events to your webhook URL.
document_created | When a document is created. |
document_sent | When a document is sent. |
document_viewed | When a signer views a document. Called each time a signer views the document. |
document_in_progress | Called once. When a document has started to be completed and status changes to in progress (pending in the API return data). |
document_recipients_updated | When a document's recipients are updated after it has been sent. |
document_signed | Called each time a document is signed by a recipient. A document may have multiple recipients that need to sign, this would be called for each one. Note: this event is not emitted solely because a pre-signed template signature/initials was copied as document content. |
document_completed | When a document is completed (signed by all recipients). |
document_expired | When a document has expired. |
document_canceled | When a document is canceled by the sender. |
document_declined | When a document is declined by a signer. |
document_bounced | When the email delivery to a signer bounced. |
document_error | When there's an error creating or updating a document. |
template_created | When a template is created. |
template_error | When there's an error creating or updating a template. |
template_available | When a template becomes available to use: when it is finished in the app (including again after its files are replaced), when it is created through the API without draft: true, or when a draft template is updated through the API without draft: true. Updates to a template that is already available do not send it. |
template_unavailable | When an available template stops being usable: when the sender starts changing it (Update to replace its files, or editing its recipients in the embedded editor), or when it is blocked for review, which is checked when its template link is opened. template_available is sent again once it is finished. Archiving or deleting a template does not send it. |
document_sms_failed | When an SMS notification to a recipient reaches a terminal failure (undelivered or failed). |
document_sms_opted_out | When a recipient's phone number is newly added to the SMS suppression list (the recipient opted out, for example by replying STOP). |
