Signwell
signwellSignWell is an electronic signature tool for legally binding e-signatures and faster document signing.
Acciones disponibles (8)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create DocumentSIGNWELL_CREATE_DOCUMENTAcciónTool 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.
SIGNWELL_CREATE_DOCUMENTAcciónTool 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.
Parámetros de entrada
draftbooleanIf true, saves document as draft (no emails sent). If false, sends signature requests immediately.
filesobject[]ObligatorioList of files to include in the document. At least one file is required.
messagestringEmail message for the signature request. Defaults to system or template message.
subjectstringEmail subject for the signature request. Defaults to system or template subject.
languagestringISO 639-1 code for localization (e.g., en, fr, es). Defaults to en.
metadataobjectOptional key/value data associated with the document.
remindersbooleanIf true, sends reminders on day 3, 6, and 10.
test_modebooleanSet to true to enable Test Mode (not legally binding & not billed). Defaults to false.
text_tagsbooleanIf true, you may place fields via special text tags in your document.
expires_inintegerNumber of days before the request expires (>=1). Defaults to account or template setting.
recipientsobject[]ObligatorioPeople who must complete and/or sign this document.
redirect_urlstringURL to redirect recipients to after successful signing.
allow_declinebooleanIf true, recipients may decline to sign (which cancels the request).
allow_reassignbooleanIf true, signers may reassign their signing responsibility.
embedded_signingbooleanIf true, enables embedded signing (iframe) and disables email auth.
api_application_idstringUUID of API Application settings to use (optional).
apply_signing_orderbooleanIf true, enforces signing in the order provided by recipients.
with_signature_pagebooleanIf true, appends a signature page to the end and requires signing there.
decline_redirect_urlstringURL to redirect recipients to if they decline to sign.
custom_requester_namestringCustom name used in all email communications and audit records.
custom_requester_emailstringCustom email used in communications instead of the API key owner.
embedded_signing_notificationsbooleanIf true, sends completion notifications when using embedded signing.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookSIGNWELL_CREATE_WEBHOOKAcciónTool to register a webhook callback url. use when you need to receive document event notifications.
SIGNWELL_CREATE_WEBHOOKAcciónTool to register a webhook callback url. use when you need to receive document event notifications.
Parámetros de entrada
callbackUrlstringObligatorioURL where SignWell will post document event payloads.
apiApplicationIdstringUUID of the API Application to associate with this webhook.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DocumentSIGNWELL_DELETE_DOCUMENTAcciónTool to delete a document (and cancel signing if in progress). use when you need to remove a document by id after confirming it.
SIGNWELL_DELETE_DOCUMENTAcciónTool to delete a document (and cancel signing if in progress). use when you need to remove a document by id after confirming it.
Parámetros de entrada
idstringObligatorioUnique identifier for a document
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookSIGNWELL_DELETE_WEBHOOKAcciónTool to delete a registered webhook. use when you need to remove a webhook no longer sending events.
SIGNWELL_DELETE_WEBHOOKAcciónTool to delete a registered webhook. use when you need to remove a webhook no longer sending events.
Parámetros de entrada
idstringObligatorioUnique identifier for the webhook
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CredentialsSIGNWELL_GET_CREDENTIALSAcciónTool to retrieve account information for the current api key. use when validating credentials and obtaining user details.
SIGNWELL_GET_CREDENTIALSAcciónTool to retrieve account information for the current api key. use when validating credentials and obtaining user details.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DocumentSIGNWELL_GET_DOCUMENTAcciónTool to return a document and all associated document data. use when you need to fetch document details by id.
SIGNWELL_GET_DOCUMENTAcciónTool to return a document and all associated document data. use when you need to fetch document details by id.
Parámetros de entrada
idstringObligatorioThe unique identifier for the document to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Bulk SendsSIGNWELL_LIST_BULK_SENDSAcciónTool to list all bulk sends. use after setting up api credentials to retrieve paginated records.
SIGNWELL_LIST_BULK_SENDSAcciónTool to list all bulk sends. use after setting up api credentials to retrieve paginated records.
Parámetros de entrada
pageintegerPage number for pagination. Defaults to 1.
emailstringEmail address of the user that sent the Bulk Send. Requires admin or manager role to view other users' sends.
per_pageintegerNumber of results per page. Defaults to 10, maximum 50.
api_application_idstringUnique identifier for API Application settings to scope the request.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List WebhooksSIGNWELL_LIST_WEBHOOKSAcciónTool to list all registered webhooks. use when you need to retrieve the active webhooks for your signwell account after setup.
SIGNWELL_LIST_WEBHOOKSAcciónTool to list all registered webhooks. use when you need to retrieve the active webhooks for your signwell account after setup.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not