Prerequisites
The connector should already be set up, with a Connector Profile and a Linked Account. See Getting Started on the SignWell connector page.Automatic webhook setup
SignWell webhook subscriptions are created and managed automatically by StackOne. When you connect a SignWell account, StackOne registers a webhook subscription with SignWell using your API key, and removes it automatically if the account is disconnected. There is nothing to configure in SignWell — you only need to select which events to receive in StackOne.
Available webhook events
The following SignWell events can be enabled. Only events selected in StackOne are included in the subscription — SignWell delivers every event to the subscription regardless, and StackOne routes each one to the matching handler.
Document lifecycle events
Events fired as a document moves through its pre-completion lifecycle.
- Document Created (
document_created) — Fired when a document is created - Document Sent (
document_sent) — Fired when a document is sent to its recipients - Document Viewed (
document_viewed) — Fired each time a signer views the document - Document In Progress (
document_in_progress) — Fired when a document starts being completed and its status changes to in progress - Document Recipients Updated (
document_recipients_updated) — Fired when a document’s recipients are updated after it has been sent
Document outcome events
Events fired when a document reaches a terminal or error state.
- Document Signed (
document_signed) — Fired each time a document is signed by a recipient - Document Completed (
document_completed) — Fired when a document is completed (signed by all recipients) - Document Declined (
document_declined) — Fired when a document is declined by a signer - Document Expired (
document_expired) — Fired when a document has expired - Document Canceled (
document_canceled) — Fired when a document is canceled by the sender - Document Bounced (
document_bounced) — Fired when the email delivery to a signer bounced - Document Error (
document_error) — Fired when there’s an error creating or updating a document
Template events
Events related to reusable document templates.
- Template Created (
template_created) — Fired when a template is created - Template Error (
template_error) — Fired when there’s an error creating or updating a template
SMS delivery events
Events related to SMS signing-request delivery. SignWell only sends these two events to webhooks that carry an API Application ID — configure the optional API Application ID field on this connection to receive them.
- Document SMS Failed (
document_sms_failed) — Fired when an SMS notification to a recipient reaches terminal delivery failure - Document SMS Opted Out (
document_sms_opted_out) — Fired when a recipient’s phone number is newly added to the SMS suppression list
Delivery format
Details of how SignWell delivers events to StackOne.
One event per request
SignWell sends one event per webhook request — it does not batch multiple events into a single delivery. Each request carries an event envelope (type, time, hash) and a data envelope (the affected document or template, and the SignWell account id).