Skip to main content
Signwell logo
  • Category: signatures
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: SIGNWELL
  • Version: 20261101_00

Tools

Slug: SIGNWELL_CREATE_DOCUMENTTool to create and optionally send a new document for signing. Use when you have files and recipients defined and want to programmatically submit a signature request in one call.

Input Parameters

boolean
If true, saves document as draft (no emails sent). If false, sends signature requests immediately.
array
required
List of files to include in the document. At least one file is required.
string
Email message for the signature request. Defaults to system or template message.
string
Email subject for the signature request. Defaults to system or template subject.
string
ISO 639-1 code for localization (e.g., en, fr, es). Defaults to en.
object
Optional key/value data associated with the document.
boolean
If true, sends reminders on day 3, 6, and 10.
boolean
Set to true to enable Test Mode (not legally binding & not billed). Defaults to false.
boolean
If true, you may place fields via special text tags in your document.
integer
Number of days before the request expires (>=1). Defaults to account or template setting.
array
required
People who must complete and/or sign this document.
string
URL to redirect recipients to after successful signing.
boolean
If true, recipients may decline to sign (which cancels the request).
boolean
If true, signers may reassign their signing responsibility.
boolean
If true, enables embedded signing (iframe) and disables email auth.
string
UUID of API Application settings to use (optional).
boolean
If true, enforces signing in the order provided by recipients.
boolean
If true, appends a signature page to the end and requires signing there.
string
URL to redirect recipients to if they decline to sign.
string
Custom name used in all email communications and audit records.
string
Custom email used in communications instead of the API key owner.
boolean
If true, sends completion notifications when using embedded signing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_CREATE_DOCUMENT_FROM_TEMPLATETool to create and optionally send a new document for signing from a template. Use when you need to generate a document using a pre-configured template with placeholders. If draft is set to true the document will not be sent.

Input Parameters

string
Name of the document being created from the template.
boolean
If true, saves document as draft without sending. If false, sends for signing immediately. Defaults to false.
array
Additional files to append to the document. Will not replace existing template files.
array
Fields to add to appended files (not existing template files). 2D array - one array of fields per appended file.
array
Labels for organizing documents. Updating labels replaces any existing labels.
string
Email message for the signature request. Defaults to template or system message.
string
Email subject for the signature request. Defaults to template or system subject.
object
Optional key-value metadata associated with the document. Returned in all document queries.
boolean
If true, sends reminders on day 3, 6, and 10. Defaults to true.
boolean
Set to true to enable Test Mode (not legally binding and not billed). Defaults to false.
boolean
If true, enables special text tags for placing fields in documents. Defaults to false.
integer
Number of days before the signature request expires (minimum 1). Defaults to account or template setting.
array
required
Document recipients assigned to template placeholders. Recipients inherit placeholder fields and settings.
string
UUID of a single template to use. Either template_id or template_ids must be provided, not both.
string
URL to redirect recipients to after successfully signing the document.
array
List of template UUIDs to use for creating a multi-template document. Either template_id or template_ids must be provided, not both.
boolean
If true, recipients may decline to sign (which cancels the entire document). Defaults to true.
boolean
If true, signers may reassign their signing responsibility to another person. Defaults to true.
array
Contacts who receive the final document once all recipients complete signing.
array
Template fields to prepopulate with values. Cannot prepopulate Signature or Initials fields.
boolean
If true, enables embedded signing (iframe) and disables email authentication. Defaults to false.
string
UUID of API Application settings to use for OAuth isolation or embedded API settings.
boolean
If true, enforces signing in the order provided by recipients array. Defaults to false.
array
Attachments that recipients must upload to complete signing. Shown after all document fields are completed.
boolean
If true, appends a signature page to the end and requires all signers to sign there. Defaults to false.
string
URL to redirect recipients to if they decline to sign.
string
Custom name used in all email communications, notifications, and audit file.
string
Custom email used for all communications and audit file instead of the API key owner’s email.
boolean
If true, sends completion notifications when using embedded signing. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_CREATE_WEBHOOKTool to register a webhook callback URL. Use when you need to receive document event notifications.

Input Parameters

string
required
URL where SignWell will post document event payloads.
string
UUID of the API Application to associate with this webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_DELETE_DOCUMENTTool to delete a document (and cancel signing if in progress). Use when you need to remove a document by ID after confirming it.

Input Parameters

string
required
The unique identifier (UUID) of the document to delete. This ID is returned when creating a document via SIGNWELL_CREATE_DOCUMENT or can be retrieved using SIGNWELL_GET_DOCUMENT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_DELETE_WEBHOOKDeletes a registered webhook by its ID. Use this to remove webhooks that are no longer needed. Returns no content on success.

Input Parameters

string
required
The UUID of the webhook to delete. Obtain this from the list webhooks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_GET_CREDENTIALSRetrieve account, user, workspace, and contact information associated with the authenticated API key. The response includes account capability flags and user and account IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_GET_DOCUMENTFetch a document by ID and return its document details, including recipient and signing information.

Input Parameters

string
required
The unique identifier (UUID) for the document to retrieve. This ID is returned when creating a document via the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_LIST_BULK_SENDSTool to list all Bulk Sends. Use after setting up API credentials to retrieve paginated records.

Input Parameters

integer
Page number for pagination. Defaults to 1.
string
Email address of the user that sent the Bulk Send. Requires admin or manager role to view other users’ sends.
integer
Number of results per page. Defaults to 10, maximum 50.
string
Unique identifier for API Application settings to scope the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_LIST_WEBHOOKSTool to list all registered webhooks. Use when you need to retrieve the active webhooks for your SignWell account after setup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_SEND_REMINDERSend a reminder for a document to recipients who have not signed yet. Recipients are reminded through their configured delivery method, which may be email, SMS, or both.

Input Parameters

string
required
The unique identifier (UUID) of the document for which to send reminders. This ID is returned when creating a document via SIGNWELL_CREATE_DOCUMENT or can be retrieved using SIGNWELL_GET_DOCUMENT.
array
Optional list of specific recipients within the document to send a reminder email to. If none are specified, all recipients that have not signed yet will receive a reminder email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_UPDATE_AND_SEND_DOCUMENTTool to update a draft document and send it to recipients for signing. Use when you need to modify document settings and initiate the signing process.

Input Parameters

string
required
Unique identifier for the document to update and send.
string
The name of the document.
array
Labels to organize documents. Updating labels replaces any existing labels for this document.
string
Email message for the signature request that recipients will see. Defaults to system or template message.
string
Email subject for the signature request that recipients will see. Defaults to system or template subject.
object
Optional key-value data associated with the document. Available every time document data is returned.
boolean
Whether to send signing reminders to recipients. Reminders are sent on day 3, 6, and 10 if enabled.
boolean
Set to true to enable Test Mode. Test Mode documents do not count towards API billing and are not legally binding.
integer
Number of days before the signature request expires. Defaults to the account or template expiration setting.
string
URL that recipients are redirected to after successfully signing the document.
boolean
Whether to allow recipients the option to decline signing. If multiple signers are involved, any recipient can cancel the entire process by declining.
boolean
Allows signers to reassign their signing responsibilities to another person if they are not the right person to sign.
boolean
When set to true, enables embedded signing in your website/web application via iFrame with email authentication disabled.
string
Unique identifier for API Application settings to use. Mainly used for isolating OAuth apps or for more control over embedded API settings.
boolean
When set to true, recipients will sign one at a time in the order specified.
string
URL that recipients are redirected to if the document is declined.
string
Custom requester name used for all email communications, signing notifications, and in the audit file.
string
Custom requester email used for all email communications, signing notifications, and in the audit file.
boolean
For embedded signing, setting this to true will send out final completion notification emails to document owners and CC’d contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIGNWELL_UPDATE_TEMPLATETool to update an existing template in SignWell. Use when you need to modify template properties such as name, subject, message, reminders, expiration, or other settings.

Input Parameters

string
required
Unique identifier for the template to update.
string
The name of the template.
boolean
Whether the template can still be updated before it is ready for usage. If set to false the template is marked as Available and ready for use.
array
Labels can be used to organize templates in a way that makes them easy to find using template search in SignWell. A template can have multiple labels. Updating labels on a template will replace any existing labels.
string
Email message for the signature request that recipients will see. Defaults to the default system message or template message.
string
Email subject for the signature request that recipients will see. Defaults to the default system subject or template subject.
object
Optional key-value data that can be associated with the template. If set, will be available every time the template data is returned.
boolean
Whether to send signing reminders to recipients. Reminders are sent on day 3, day 6, and day 10 if set to true.
integer
Number of days before the signature request expires. Defaults to the account expiration setting or template expiration.
string
A URL that recipients are redirected to after successfully signing a document.
boolean
Whether to allow recipients the option to decline signing a document. If multiple signers are involved, any single recipient can cancel the entire document signing process by declining to sign.
boolean
In some cases a signer is not the right person to sign and may need to reassign their signing responsibilities to another person. This feature allows them to reassign the document to someone else.
string
Unique identifier for API Application settings to use. API Applications are optional and mainly used when isolating OAuth apps or for more control over embedded API settings.
boolean
When set to true recipients will sign one at a time in the order of the recipients collection.
string
A URL that recipients are redirected to if the document is declined.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not