Skip to content
Scalekit Docs
Talk to an EngineerDashboard

Signwell connector

API KeyFiles & DocumentsProductivityAutomation

Signwell is an e-signature platform for sending, signing, and managing documents. Connect to create and send documents for signature, manage templates...

Signwell connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Set up the connector

    Section titled “Set up the connector”

    Register your Signwell API key with Scalekit so it can authenticate and proxy requests on behalf of your users. Signwell uses API key authentication — there is no redirect URI or OAuth flow.

    1. Get a Signwell API key

      • Sign in to signwell.com and go to Settings → API.

      • Under Your API Key, click Copy to copy your key.

        Signwell API settings page showing the API key field and usage limits

    2. Create a connection in Scalekit

      • In the Scalekit dashboard, go to AgentKit → Connections → Create Connection.
      • Search for Signwell and click Create.
      • Note the Connection name — use this as connection_name in your code (e.g., signwell).

    3. Add a connected account

      Connected accounts link a specific user identifier in your system to a Signwell API key. Add them via the dashboard for testing, or via the Scalekit API in production.

      Via dashboard (for testing)

      • Open the connection and click the Connected Accounts tab → Add account.
      • Fill in Your User’s ID and API Key, then click Save.

      Via API (for production)

      await scalekit.connect.upsertConnectedAccount({
        connectionName: 'signwell',
        identifier: 'user@example.com',
        credentials: { apiKey: 'your-signwell-api-key' },
      })

  4. Make your first call

    Section titled “Make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'signwell'
    const identifier = 'user_123'
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'signwell_get_me',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Create bulk send, document, document from template — Create a bulk send to send a document to many recipients at once using a CSV file and one or more templates
  • Delete api application, document, template — Permanently delete an API Application from the Signwell account
  • Get api application, bulk send, bulk send csv template — Get details of a specific API Application including preferences and owner information
  • List bulk sends, webhooks — List all bulk sends in the account with pagination support
  • Send document, reminder, validate bulk — Update a draft document and send it to recipients for signing
  • Update authentication, recipients, template — Update passcode delivery settings for recipients on a sent document

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

signwell_create_bulk_send#Create a bulk send to send a document to many recipients at once using a CSV file and one or more templates.10 params

Create a bulk send to send a document to many recipients at once using a CSV file and one or more templates.

NameTypeRequiredDescription
bulk_send_csvstringrequiredRFC 4648 base64-encoded CSV file content. Use Get Bulk Send CSV Template to retrieve the correct column format.
template_idsarrayrequiredArray of template ID strings (UUIDs) to use for the bulk send.
api_application_idstringoptionalAPI Application ID for branding the signing experience.
apply_signing_orderbooleanoptionalRecipients sign one at a time in order.
custom_requester_emailstringoptionalCustom requester email shown in all communications to recipients.
custom_requester_namestringoptionalCustom requester name shown in all communications to recipients.
messagestringoptionalEmail message body for the signature request sent to each recipient.
namestringoptionalName for the bulk send, used as the document name for each recipient.
skip_row_errorsbooleanoptionalSkip rows with errors instead of failing the entire bulk send.
subjectstringoptionalEmail subject for the signature request sent to each recipient.
signwell_create_document#Create and optionally send a new document for signing. Set draft to true to save without sending.18 params

Create and optionally send a new document for signing. Set draft to true to save without sending.

NameTypeRequiredDescription
filesarrayrequiredArray of file objects to include in the document. Each object must have a 'name' (with a valid extension such as .pdf, .doc, .docx, .pages, .jpg) and either 'file_url' (a publicly accessible URL) or 'file_base64' (base64-encoded file content).
recipientsarrayrequiredArray of recipient objects. Each must have an 'id' (unique string identifier, e.g. '1'), 'email', and optionally 'name', 'passcode', 'subject', 'message'.
allow_declinebooleanoptionalAllow recipients to decline signing the document.
allow_reassignbooleanoptionalAllow recipients to reassign signing to another person.
apply_signing_orderbooleanoptionalRequire recipients to sign one at a time in the specified order.
custom_requester_emailstringoptionalCustom email address shown to recipients in email communications.
custom_requester_namestringoptionalCustom name shown to recipients in email communications.
draftbooleanoptionalIf true, saves the document as a draft without sending it to recipients.
embedded_signingbooleanoptionalEnable embedded signing so recipients can sign within an iFrame on your website.
expires_inintegeroptionalNumber of days before the signing request expires (1–365).
languagestringoptionalLanguage for the recipient signing UI. ISO 639-1 code.
messagestringoptionalEmail message body sent to recipients with the signing request (max 4000 chars).
metadataobjectoptionalKey-value metadata to attach to the document (max 50 pairs, keys max 40 chars, values max 500 chars).
namestringoptionalDisplay name of the document.
redirect_urlstringoptionalURL to redirect recipients to after they complete signing.
remindersbooleanoptionalSend automatic reminder emails to recipients on days 3, 6, and 10 after the initial request.
subjectstringoptionalEmail subject line for the signature request sent to recipients (max 255 chars).
test_modebooleanoptionalWhen true, the document is created in test mode and does not count toward billing.
signwell_create_document_from_template#Create a document for signing from an existing template. Assign recipients to template placeholders and optionally pre-fill field values.17 params

Create a document for signing from an existing template. Assign recipients to template placeholders and optionally pre-fill field values.

NameTypeRequiredDescription
recipientsarrayrequiredArray of recipient objects mapping to template placeholders. Each must have 'id' (unique recipient identifier, any string), 'placeholder_name' (matching the template placeholder's name exactly, e.g. 'Signer'), and 'email'. Optionally include 'name'.
template_idstringrequiredTemplate ID (UUID) to create the document from.
allow_declinebooleanoptionalIf true, allows recipients to decline signing the document.
allow_reassignbooleanoptionalIf true, allows recipients to reassign the signing request to another person.
apply_signing_orderbooleanoptionalIf true, recipients must sign in the sequential order defined in the template.
custom_requester_emailstringoptionalCustom requester email address shown to recipients instead of the account owner's email.
custom_requester_namestringoptionalCustom requester name shown to recipients instead of the account owner's name.
draftbooleanoptionalIf true, saves the document as a draft without sending it to recipients.
expires_inintegeroptionalNumber of days before the signing request expires.
fieldsarrayoptionalPre-filled field values for template fields. Each object has 'api_id' (the field's api_id from the template) and 'value'.
messagestringoptionalEmail message body sent to recipients. Overrides the template's default message. Maximum 4000 characters.
metadataobjectoptionalKey-value metadata to attach to the document for your own reference.
namestringoptionalName of the document to create. Displayed in the Signwell dashboard and emails.
redirect_urlstringoptionalURL to redirect signers to after they complete signing.
remindersbooleanoptionalIf true, automatic reminder emails will be sent to unsigned recipients.
subjectstringoptionalEmail subject line sent to recipients. Overrides the template's default subject. Maximum 255 characters.
test_modebooleanoptionalIf true, creates the document in test mode. Test mode documents do not count toward billing.
signwell_create_template#Create a new reusable signing template with placeholders for recipients and optional pre-placed fields.14 params

Create a new reusable signing template with placeholders for recipients and optional pre-placed fields.

NameTypeRequiredDescription
filesarrayrequiredArray of file objects. Each must have 'name' (with valid extension) and either 'file_url' (public URL) or 'file_base64' (base64-encoded content).
placeholdersarrayrequiredArray of placeholder objects. Each must have 'id' (unique string) and 'name' (role name, e.g. 'Client'). Optional: 'preassigned_recipient_name', 'preassigned_recipient_email'.
allow_declinebooleanoptionalAllow recipients to decline signing.
allow_reassignbooleanoptionalAllow recipients to reassign the signing request to someone else.
apply_signing_orderbooleanoptionalSequential signing order — recipients sign one at a time in order.
draftbooleanoptionalIf true, template is not yet available for use.
expires_inintegeroptionalDays before signature request expires.
languagestringoptionalLanguage code (ISO 639-1) for the signing interface.
messagestringoptionalDefault email message (max 4000 chars).
metadataobjectoptionalArbitrary key-value metadata to associate with the template.
namestringoptionalTemplate name.
redirect_urlstringoptionalPost-signing redirect URL.
remindersbooleanoptionalSend reminder emails to recipients who have not yet signed.
subjectstringoptionalDefault email subject for documents created from this template.
signwell_create_webhook#Register a webhook callback URL to receive document lifecycle events (sent, viewed, signed, completed, declined, etc.).2 params

Register a webhook callback URL to receive document lifecycle events (sent, viewed, signed, completed, declined, etc.).

NameTypeRequiredDescription
callback_urlstringrequiredHTTPS URL to POST document events to.
api_application_idstringoptionalScope the webhook to a specific API Application ID.
signwell_delete_api_application#Permanently delete an API Application from the Signwell account.1 param

Permanently delete an API Application from the Signwell account.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the API Application to delete.
signwell_delete_document#Delete a document. Also cancels the document signing process if it is in progress.1 param

Delete a document. Also cancels the document signing process if it is in progress.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the document to delete.
signwell_delete_template#Permanently delete a document template. This action cannot be undone.1 param

Permanently delete a document template. This action cannot be undone.

NameTypeRequiredDescription
idstringrequiredTemplate ID (UUID) of the template to permanently delete.
signwell_delete_webhook#Delete a registered webhook callback URL.1 param

Delete a registered webhook callback URL.

NameTypeRequiredDescription
idstringrequiredWebhook ID (UUID).
signwell_get_api_application#Get details of a specific API Application including preferences and owner information.1 param

Get details of a specific API Application including preferences and owner information.

NameTypeRequiredDescription
idstringrequiredAPI Application ID (UUID).
signwell_get_bulk_send#Get details and status of a bulk send, including document counts and completion progress.1 param

Get details and status of a bulk send, including document counts and completion progress.

NameTypeRequiredDescription
idstringrequiredBulk send ID (UUID) to retrieve.
signwell_get_bulk_send_csv_template#Get a blank CSV template for the given template IDs. Use this to understand the required columns before creating a bulk send.2 params

Get a blank CSV template for the given template IDs. Use this to understand the required columns before creating a bulk send.

NameTypeRequiredDescription
template_idsarrayrequiredArray of template ID strings (UUIDs) to generate the CSV template for.
base64booleanoptionalWhen true, returns the CSV as a base64-encoded string in JSON. Recommended: true.
signwell_get_bulk_send_documents#List all documents within a bulk send with pagination support.3 params

List all documents within a bulk send with pagination support.

NameTypeRequiredDescription
idstringrequiredBulk send ID (UUID).
limitintegeroptionalNumber of results per page (1-50).
pageintegeroptionalPage number (minimum 1).
signwell_get_completed_pdf#Get the URL to download the completed signed document as PDF or ZIP. Returns a URL to the signed file.4 params

Get the URL to download the completed signed document as PDF or ZIP. Returns a URL to the signed file.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the completed document.
audit_pagebooleanoptionalInclude the audit trail page in the downloaded document.
file_formatstringoptionalFile format for the download: 'pdf' for a single PDF or 'zip' for a ZIP archive.
url_onlybooleanoptionalReturn JSON with a file_url instead of binary file data. Recommended: true.
signwell_get_document#Get a document and all associated data including recipients, fields, and signing status.1 param

Get a document and all associated data including recipients, fields, and signing status.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the document to retrieve.
signwell_get_me#Get account information and user details associated with the current API key.0 params

Get account information and user details associated with the current API key.

signwell_get_nom151_certificate#Download the NOM-151 compliance certificate for a completed document. NOM-151 is a Mexican regulatory standard for electronic signatures.3 params

Download the NOM-151 compliance certificate for a completed document. NOM-151 is a Mexican regulatory standard for electronic signatures.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the completed document.
object_onlybooleanoptionalIf true, returns only the certificate object without additional metadata.
url_onlybooleanoptionalIf true, returns only a URL to download the certificate instead of the full object.
signwell_get_template#Get a document template and all associated template data including placeholders and fields.1 param

Get a document template and all associated template data including placeholders and fields.

NameTypeRequiredDescription
idstringrequiredTemplate ID (UUID) of the document template to retrieve.
signwell_list_bulk_sends#List all bulk sends in the account with pagination support.4 params

List all bulk sends in the account with pagination support.

NameTypeRequiredDescription
api_application_idstringoptionalFilter by API Application ID.
limitintegeroptionalNumber of results per page (1-50, max 50).
pageintegeroptionalPage number (minimum 1).
user_emailstringoptionalFilter by user email. Admins can view others' bulk sends.
signwell_list_webhooks#List all webhook subscriptions configured in the account.0 params

List all webhook subscriptions configured in the account.

signwell_send_document#Update a draft document and send it to recipients for signing.13 params

Update a draft document and send it to recipients for signing.

NameTypeRequiredDescription
idstringrequiredUnique identifier (UUID) of the draft document to send.
allow_declinebooleanoptionalAllow recipients to decline signing the document.
allow_reassignbooleanoptionalAllow recipients to reassign their signing to another person.
apply_signing_orderbooleanoptionalRequire recipients to sign one at a time in order.
custom_requester_emailstringoptionalCustom email address shown to recipients in email communications.
custom_requester_namestringoptionalCustom name shown to recipients in email communications.
embedded_signingbooleanoptionalEnable embedded signing via iFrame.
expires_inintegeroptionalNumber of days before the signing request expires (1–365).
messagestringoptionalEmail message body sent to recipients (max 4000 chars).
namestringoptionalUpdate the display name of the document before sending.
redirect_urlstringoptionalURL to redirect recipients to after they complete signing.
remindersbooleanoptionalSend automatic reminder emails on days 3, 6, and 10.
subjectstringoptionalEmail subject line for the signing request (max 255 chars).
signwell_send_reminder#Send a reminder email to recipients who have not yet signed a document.2 params

Send a reminder email to recipients who have not yet signed a document.

NameTypeRequiredDescription
idstringrequiredDocument ID (UUID) of the document to send reminders for.
recipientsarrayoptionalSpecific recipients to remind. Each object has 'email' (string) and optionally 'name' (string). If omitted, all unsigned recipients are reminded.
signwell_update_authentication#Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.2 params

Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.

NameTypeRequiredDescription
idstringrequiredDocument ID (UUID) of the document whose recipient authentication should be updated.
recipientsarrayrequiredArray of recipient authentication update objects. Each must have 'id' (recipient ID). Optional fields: 'passcode' (string), 'passcode_delivery' (object with 'enabled' bool, 'methods' array, 'expire_after_access' bool).
signwell_update_recipients#Update one or more recipients on a sent document that has not yet been fully signed. Recipients who have already started signing cannot be updated.2 params

Update one or more recipients on a sent document that has not yet been fully signed. Recipients who have already started signing cannot be updated.

NameTypeRequiredDescription
idstringrequiredDocument ID (UUID) of the document whose recipients should be updated.
recipientsarrayrequiredArray of recipient update objects. Each must have 'id' (recipient ID from Get Document), 'name' (string), and 'email' (string). Optional fields: 'subject', 'message', 'passcode'.
signwell_update_template#Update an existing document template. Replaces the template properties with the provided values.11 params

Update an existing document template. Replaces the template properties with the provided values.

NameTypeRequiredDescription
idstringrequiredTemplate ID (UUID) of the template to update.
allow_declinebooleanoptionalAllow recipients to decline signing.
allow_reassignbooleanoptionalAllow recipients to reassign the signing request to someone else.
apply_signing_orderbooleanoptionalSequential signing order — recipients sign one at a time in order.
expires_inintegeroptionalDays before signature request expires.
messagestringoptionalDefault email message (max 4000 chars).
metadataobjectoptionalArbitrary key-value metadata to associate with the template.
namestringoptionalTemplate name.
redirect_urlstringoptionalPost-signing redirect URL.
remindersbooleanoptionalSend reminder emails to recipients who have not yet signed.
subjectstringoptionalDefault email subject for documents created from this template.
signwell_validate_bulk_send_csv#Validate a bulk send CSV file before creating the bulk send. Returns validation errors by row if the CSV is invalid.2 params

Validate a bulk send CSV file before creating the bulk send. Returns validation errors by row if the CSV is invalid.

NameTypeRequiredDescription
bulk_send_csvstringrequiredRFC 4648 base64-encoded CSV file content.
template_idsarrayrequiredArray of template ID strings (UUIDs) the CSV maps to.