Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to SignWell

Scalekit connector
Open markdown

The SignWell connector lets your AI agent act in each user's SignWell account. Each user connects their own SignWell API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.

Tools
26
What they doRead · write · destructive
11 · 11 · 411 read11 write4 destructive
Users sign in with

What you can do

  • Send documents for signing: create documents from files or templates, send them to recipients, and send reminders
  • Track signing status: check a document’s recipients, fields, and signing progress, and download the completed PDF
  • Manage templates: create, update, and delete reusable templates with recipient placeholders and fields
  • Run bulk sends: validate a CSV and send one document to many recipients, then track progress
  • Manage webhooks: register, list, and delete callback URLs for events like signed, viewed, or declined

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv

  2. 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. Create the SignWell connection

    In AgentKit > Connections, create a SignWell connection. The name you give it is the connection_name your code passes. See Configure connections.

    Console steps with screenshots

    Register your SignWell API key with Scalekit so it can authenticate and proxy requests on behalf of your users. SignWell uses API key authentication.

    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 one in the dashboard to test. In production, each user adds their own through the authorization link: they enter their credentials on the page it opens.

      In the dashboard, to test

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

      From your backend, if your app already has the credentials

      For example, when users enter them on a settings page in your app:

      import { ConnectorStatus } from '@scalekit-sdk/node'
      

      const authorizationDetails = {
        details: {
          case: 'staticAuth',
          value: { details: { api_key: 'your-signwell-api-key' } },
        },
      }
      

      let { connectedAccount } = await scalekit.actions.upsertConnectedAccount({
        connectionName: 'signwell',
        identifier: 'user_123',
        authorizationDetails,
      })
      

      // Make sure the account is ACTIVE before the first tool call.
      if (connectedAccount?.status !== ConnectorStatus.ACTIVE) {
        ;({ connectedAccount } = await scalekit.actions.upsertConnectedAccount({
          connectionName: 'signwell',
          identifier: 'user_123',
          authorizationDetails,
        }))
      }

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    

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

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

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize SignWell:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    

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

    Each user opens the link once and enters their SignWell credentials there. If your app already has a user's credentials, add the account from your backend instead, as the console steps above show. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • signwell_get_api_applicationGet details of a specific API Application including preferences and owner information.Read-only

    Get API Application

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

    Inputs

    idstringrequired
    API Application ID (UUID).
  • signwell_get_bulk_sendGet details and status of a bulk send, including document counts and completion progress.Read-only

    Get Bulk Send

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

    Inputs

    idstringrequired
    Bulk send ID (UUID) to retrieve.
  • signwell_get_bulk_send_csv_templateGet a blank CSV template for the given template IDs.Read-only

    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.

    Inputs

    template_idsarrayrequired
    Array of template ID strings (UUIDs) to generate the CSV template for.
    base64boolean
    When true, returns the CSV as a base64-encoded string in JSON. Recommended: true.default true
  • signwell_get_bulk_send_documentsList all documents within a bulk send with pagination support.Read-only

    Get Bulk Send Documents

    List all documents within a bulk send with pagination support.

    Inputs

    idstringrequired
    Bulk send ID (UUID).
    limitinteger
    Number of results per page (1-50).default 10
    pageinteger
    Page number (minimum 1).default 1
  • signwell_get_completed_pdfGet the URL to download the completed signed document as PDF or ZIP.Read-only

    Get Completed PDF

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

    Inputs

    idstringrequired
    Unique identifier (UUID) of the completed document.
    audit_pageboolean
    Include the audit trail page in the downloaded document.default true
    file_formatstring
    File format for the download: 'pdf' for a single PDF or 'zip' for a ZIP archive.one of pdfzipdefault pdf
    url_onlyboolean
    Return JSON with a file_url instead of binary file data. Recommended: true.default true
  • signwell_get_documentGet a document and all associated data including recipients, fields, and signing status.Read-only

    Get Document

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

    Inputs

    idstringrequired
    Unique identifier (UUID) of the document to retrieve.
  • signwell_get_meGet account information and user details associated with the current API key.Read-only

    Get Me

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

    Inputs

    This tool takes no inputs.

  • signwell_get_nom151_certificateDownload the NOM-151 compliance certificate for a completed document.Read-only

    Get NOM-151 Certificate

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

    Inputs

    idstringrequired
    Unique identifier (UUID) of the completed document.
    object_onlyboolean
    If true, returns only the certificate object without additional metadata.
    url_onlyboolean
    If true, returns only a URL to download the certificate instead of the full object.
All 33 in Files & Documents