Skip to main content
SignWell
Previewv0.1.0
23 actions · 5 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.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

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

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

23 actions
Action
Description
Get Account
Retrieve the account’s branding, locale, and default settings.
Update Account
Change account branding, locale, and default document settings.
List Bulk Sends
Return a paginated list of bulk sends on the account.
Create Bulk Send
Send a document to many recipients at once from a CSV.
Validate Bulk Send CSV
Validate a bulk send CSV.
Get Document
Retrieve a document and all of its associated data.
Create Document
Create and optionally send a new document for signing.
Create Document From Template
Create a document from one or more templates.
Update And Send Document
Update a draft document and send it to recipients.
Send Reminder
Send a signing reminder to a document’s recipients.
Update Authentication
Update recipient authentication settings on a document.
Update Recipients
Update the recipients on a document.
Delete Document
Permanently remove a document and its data from the account.
Get Completed Pdf
Retrieve the completed PDF for a document.
Get NOM-151 Certificate
Retrieve the NOM-151 certificate for a document.
Get Credentials
Return the API key and account details for the current connection.
Get Template
Retrieve a template including its placeholders and fields.
Update Template
Modify an existing template’s fields, placeholders, and settings.
Delete Template
Permanently remove a template from the account.
Create Template
Build a reusable template from uploaded files and fields.
List Webhooks
Return all webhook subscriptions configured on the account.
Create Webhook
Register a callback URL to receive document event notifications.
Delete Webhook
Stop event delivery by removing a webhook subscription.

Events

|
5 events
Event
Description
Tags
Webhook Verification
Acknowledges a SignWell webhook delivery that doesn’t match one of the mapped event types. SignWell has no challenge/pin…
Verification
Document Lifecycle Event
Processes SignWell document lifecycle webhook events (created, sent, viewed, in progress, recipients updated).
Documents
Document Outcome Event
Processes SignWell document outcome webhook events (signed, completed, declined, expired, canceled, bounced, error).
Documents
Template Event
Processes SignWell template webhook events (created, error).
Templates
Document SMS Event
Processes SignWell SMS delivery webhook events (failed, opted out). Only delivered to webhooks that carry an `api_applic…
DocumentsSMS