Skip to main content
Use SignWell through Corsair: one client, typed API calls, and incoming webhooks. Create an API token in SignWell under Settings, then API. Pass it as the plugin’s key option or store it on the account. SignWell reads it from the X-Api-Key header. Things to know before you send:
  • Sending notifies real people. documents.create and documents.createFromTemplate notify every recipient unless you set draft: true. bulkSends.create has no draft or test mode: it sends every row as soon as it is created. Test mode keeps a document out of billing and makes it non-binding, but the notifications still go out.
  • Test mode does not follow a draft. SignWell documents that a document created in test mode is not automatically sent in test mode. The document routes (documents.create, documents.createFromTemplate, documents.send) accept test_mode, and the plugin also sets X-TestMode-Enabled so the two never disagree.
  • Recipient ids change meaning. At creation, recipients[].id is the number you assign to attach fields. After the document exists, the id comes from documents.get, and documents.updateRecipients needs that one.
  • Only unsigned recipients can change. Updating a recipient or their passcode fails with a 409 once that recipient has started signing.
  • Completed files come back as a URL. SignWell returns a PDF or ZIP body by default, which this plugin cannot hand back intact, so documents.getCompletedPdf and documents.getNom151Certificate ask for url_only and return file_url.
  • Webhooks. Register a URL with webhooks.create, then give the returned id to the plugin as webhookSecret (or store it as the account’s webhook signature). SignWell signs each delivery with HMAC-SHA256 over event.type@event.time, keyed with that id; a delivery whose hash does not match is refused.
  • What the signature covers. The hash covers the event type and its timestamp, not the document body, so it stops an unsigned sender but not a replay of a genuine envelope. Treat a delivery as a notification to go read the document, not as the document’s final state.
  • Paging. bulkSends.list and bulkSends.getDocuments page by number and report next_page. webhooks.list does not page.
What you get:
  • 28 typed API operations
  • 10 incoming webhook event types

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

Read a document and its recipients
Send a PDF for signature
See the full list on the API page.

Webhooks

This plugin registers 10 webhook event types. Configure the provider to POST to your Corsair HTTP handler, then use webhookHooks on the plugin factory. See Webhooks for every event path and payload shape, and Webhooks concept for routing.

What’s next

API reference

Every signwell.api.* operation with input and output types.

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.