> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SignWell

> How to set up the SignWell connector, plus the actions and events that are available.

![SignWell](https://stackone-logos.com/api/signwell/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/signwell/changelog.md)

[23 actions](#actions) · [5 events](#events) · 1 auth method

E-Signature

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](https://docs.stackone.com/connectors/signwell/guides/connector-profile/api-key.md)**
>
> Uses an API key sent in the X-Api-Key header. The key is generated on the SignWell Settings > API page and inherits the...

Optionally, configure receiving Events for SignWell into StackOne.

> **[Webhooks setup](https://docs.stackone.com/connectors/signwell/guides/webhook-setup.md)**

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](https://docs.stackone.com/connectors/signwell/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

23 actions

ActionDescription

Get Account`signwell_get_account`

Retrieve the account's branding, locale, and default settings.

Update Account`signwell_update_account`

Change account branding, locale, and default document settings.

List Bulk Sends`signwell_list_bulk_sends`

Return a paginated list of bulk sends on the account.

Create Bulk Send`signwell_create_bulk_send`

Send a document to many recipients at once from a CSV.

Validate Bulk Send CSV`signwell_validate_bulk_send_csv`

Validate a bulk send CSV.

Get Document`signwell_get_document`

Retrieve a document and all of its associated data.

Create Document`signwell_create_document`

Create and optionally send a new document for signing.

Create Document From Template`signwell_create_document_from_template`

Create a document from one or more templates.

Update And Send Document`signwell_update_and_send_document`

Update a draft document and send it to recipients.

Send Reminder`signwell_send_reminder`

Send a signing reminder to a document's recipients.

Update Authentication`signwell_update_authentication`

Update recipient authentication settings on a document.

Update Recipients`signwell_update_recipients`

Update the recipients on a document.

Delete Document`signwell_delete_document`

Permanently remove a document and its data from the account.

Get Completed Pdf`signwell_get_completed_pdf`

Retrieve the completed PDF for a document.

Get NOM-151 Certificate`signwell_get_nom151_certificate`

Retrieve the NOM-151 certificate for a document.

Get Credentials`signwell_get_credentials`

Return the API key and account details for the current connection.

Get Template`signwell_get_template`

Retrieve a template including its placeholders and fields.

Update Template`signwell_update_template`

Modify an existing template's fields, placeholders, and settings.

Delete Template`signwell_delete_template`

Permanently remove a template from the account.

Create Template`signwell_create_template`

Build a reusable template from uploaded files and fields.

List Webhooks`signwell_list_webhooks`

Return all webhook subscriptions configured on the account.

Create Webhook`signwell_create_webhook`

Register a callback URL to receive document event notifications.

Delete Webhook`signwell_delete_webhook`

Stop event delivery by removing a webhook subscription.

## Events

Tags

Select all
|
Clear

Documents

SMS

Templates

Verification

No tags found

5 events

EventDescriptionTags

Webhook Verification`signwell_webhook_verify`

Acknowledges a SignWell webhook delivery that doesn't match one of the mapped event types. SignWell has no challenge/pin...

Verification

Document Lifecycle Event`signwell_webhook_document_lifecycle`

Processes SignWell document lifecycle webhook events (created, sent, viewed, in progress, recipients updated).

Documents

Document Outcome Event`signwell_webhook_document_outcome`

Processes SignWell document outcome webhook events (signed, completed, declined, expired, canceled, bounced, error).

Documents

Template Event`signwell_webhook_template_event`

Processes SignWell template webhook events (created, error).

Templates

Document SMS Event`signwell_webhook_document_sms`

Processes SignWell SMS delivery webhook events (failed, opted out). Only delivered to webhooks that carry an \`api\_applic...

DocumentsSMS


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.