Skip to main content
The SignWell plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see Overview for setup context and the exact URL shape).
New to Corsair? See webhooks and hooks.

Webhook map

  • document
    • canceled (document.canceled)
    • completed (document.completed)
    • created (document.created)
    • declined (document.declined)
    • expired (document.expired)
    • inProgress (document.inProgress)
    • recipientsUpdated (document.recipientsUpdated)
    • sent (document.sent)
    • signed (document.signed)
    • viewed (document.viewed)

HTTP handler setup

app/api/webhook/route.ts

Events

Document

Canceled

document.canceled The sender canceled the document. Payload
webhookHooks example

Completed

document.completed Every recipient signed and the document is complete. Payload
webhookHooks example

Created

document.created A document was created. Payload
webhookHooks example

Declined

document.declined A recipient declined to sign. Payload
webhookHooks example

Expired

document.expired The document passed its expiry date without being completed. Payload
webhookHooks example

In Progress

document.inProgress The first signer started filling the document; SignWell sends this once. Payload
webhookHooks example

Recipients Updated

document.recipientsUpdated A sent document’s recipients were changed. Payload
webhookHooks example

Sent

document.sent A document was sent to its recipients. Payload
webhookHooks example

Signed

document.signed One recipient signed. A document with several signers sends this once per signer. Payload
webhookHooks example

Viewed

document.viewed A signer opened the document. SignWell sends this once per view. Payload
webhookHooks example