Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Formcarry

Scalekit connector
Open markdown

The Formcarry connector lets your AI agent act in each user's Formcarry account. Each user connects their own Formcarry access token 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
14 · 8 · 414 read8 write4 destructive
Users sign in with

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 Formcarry connection

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

  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 = 'formcarry'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Formcarry:', 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: 'formcarry_email_servers_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Formcarry credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • formcarry_email_servers_listList the email servers set up in the dashboard for sending notifications: your own SMTP servers (email_server) and verified sending domains (premium_server).Read-only

    List Email Servers

    List the email servers set up in the dashboard for sending notifications: your own SMTP servers (email_server) and verified sending domains (premium_server). Returns each server's id, type and details. Use the id as self_email_notification.sender.server_id in Create Form or Update Form.

    Inputs

    This tool takes no inputs.

  • formcarry_form_fields_listList the field names in the form's newest 2,000 submissions, most used first (up to 200 names).Read-only

    List Form Fields

    List the field names in the form's newest 2,000 submissions, most used first (up to 200 names). Returns each field name with how many submissions carry it and when it was last seen. Use this to pick field names for the fields filter or group_by in submission tools.

    Inputs

    form_idstringrequired
    ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
  • formcarry_form_getGet one form with its full configuration.Read-only

    Get Form

    Get one form with its full configuration. Returns the form's id, name, endpoint URL, active state and storage, spam, notification, auto-response, after-submit and validation settings. Use this when you know the form ID. Use List Forms to find it.

    Inputs

    form_idstringrequired
    ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
  • formcarry_forms_listList the forms the API key can access, newest first, each with its full configuration.Read-only

    List Forms

    List the forms the API key can access, newest first, each with its full configuration. Returns data[] of forms with id, name, endpoint URL and settings, plus next_cursor. Use this to find a form ID. Use Get Form for one form.

    Inputs

    cursorstring
    next_cursor from the previous page. Example: eyJpZCI6IjY2NTAifQ.
    limitinteger
    Forms per page, 1 to 100 (default 25). Example: 50.
    team_idstring
    Only forms of this team (one the key covers). Example: 64b000000000000000000001.
  • formcarry_me_getGet the API key used for this connection: its scopes and the teams and forms it can access.Read-only

    Get API Key Details

    Get the API key used for this connection: its scopes and the teams and forms it can access. Returns the key's id, scopes and accessible teams and forms. Use this to check what the key may do before calling other tools.

    Inputs

    This tool takes no inputs.

  • formcarry_submission_deliveries_getGet what happened to up to 20 submissions after they arrived: every email, webhook, Zapier zap and integration each was sent to, with the latest outcome.Read-only

    Get Submission Deliveries

    Get what happened to up to 20 submissions after they arrived: every email, webhook, Zapier zap and integration each was sent to, with the latest outcome. Returns one row per target and a rolled-up status per submission (null when older than 18 months). Use this to debug missing notifications. Use List Webhook Deliveries for one webhook's log.

    Inputs

    form_idstringrequired
    ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
    submission_idsstringrequired
    1 to 20 submission IDs of this form, comma-separated. Example: 6650f0e1d2c3b4a596877766,6650f0e1d2c3b4a596877767.
  • formcarry_submission_getGet one submission with its fields and uploaded files.Read-only

    Get Submission

    Get one submission with its fields and uploaded files. Returns the submission's id, fields, files, status and created_at. Use this when you know the submission ID. Use List Submissions to find it.

    Inputs

    form_idstringrequired
    ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
    submission_idstringrequired
    ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
  • formcarry_submissions_countCount one form's submissions matching the same filters as List Submissions, optionally grouped by day, week, month, country, spam, read or a field.Read-only

    Count Submissions

    Count one form's submissions matching the same filters as List Submissions, optionally grouped by day, week, month, country, spam, read or a field. Returns the total or the 20 largest groups plus other, and exact (false when the count timed out). Use this to size a result before listing.

    Inputs

    form_idstringrequired
    ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
    countrystring
    Only submissions from these countries: two-letter uppercase codes, comma-separated, up to 20. Example: US,CA.
    created_afterstring
    Only submissions created at or after this time (RFC 3339 or epoch milliseconds). Example: 2025-01-01T00:00:00Z.
    created_beforestring
    Only submissions created before this time (RFC 3339 or epoch milliseconds). Example: 2025-02-01T00:00:00Z.
    group_bystring
    Group the count by day, week, month, country, spam, read or field:<name>. Leave empty for one total. Example: week.
    has_attachmentsstring
    true for only submissions with uploaded files, false for only those without. Example: true.one of truefalse
    qstring
    Only submissions where any field contains this text (case-insensitive, 2 to 512 characters). Example: refund.
    readstring
    true for only submissions read in the dashboard, false for only unread ones. Example: false.one of truefalse
    statusstring
    Which submissions to include: inbox (default), spam or all. Example: inbox.one of inboxspamall