Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Benchmark Email

Scalekit connector
Open markdown

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

Tools
57
What they doRead · write · destructive
36 · 14 · 736 read14 write7 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 Benchmark Email connection

    In AgentKit > Connections, create a Benchmark Email 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 = 'benchmarkemail'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Benchmark Email:', 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: 'benchmarkemail_account_get',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Benchmark Email 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
  • benchmarkemail_account_getGet the Benchmark Email account profile.Read-only

    Get Account Details

    Get the Benchmark Email account profile. Returns the account's name, company, login email, address, plan and settings in Response.Data. Use it to confirm the connection works and see who the API token belongs to.

    Inputs

    This tool takes no inputs.

  • benchmarkemail_automation_getGet one automation by ID.Read-only

    Get Automation

    Get one automation by ID. Returns the automation's name, type, sender, target list, status and its emails in Response.Data. Use benchmarkemail_automations_list to find the ID.

    Inputs

    automation_idstringrequired
    ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.
  • benchmarkemail_automation_report_getGet the summary report for an automation.Read-only

    Get Automation Report

    Get the summary report for an automation. Returns sends, opens, clicks, bounces and unsubscribes for each email in the automation in Response.Data.

    Inputs

    automation_idstringrequired
    ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.
  • benchmarkemail_automations_listList automations (autoresponder series), with paging, sorting and a name filter.Read-only

    List Automations

    List automations (autoresponder series), with paging, sorting and a name filter. Returns each automation's ID, name, status, list and email count in Response.Data. Use benchmarkemail_automation_get for one automation's details.

    Inputs

    This tool takes no inputs.

  • benchmarkemail_confirmed_emails_listList the sender email addresses confirmed in the account.Read-only

    List Confirmed Sender Emails

    List the sender email addresses confirmed in the account. Returns the confirmed From addresses in Response.Emails. Use it before benchmarkemail_email_create to pick a valid from_email.

    Inputs

    This tool takes no inputs.

  • benchmarkemail_contact_getGet one contact in a contact list by contact ID.Read-only

    Get Contact

    Get one contact in a contact list by contact ID. Returns the contact's email, names, field values, opt-in data and status in Response.Data. Use benchmarkemail_contacts_search or benchmarkemail_list_contacts_list to find the contact ID.

    Inputs

    contact_idstringrequired
    ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
    list_idstringrequired
    ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
  • benchmarkemail_contact_history_getGet the campaign history for one email address.Read-only

    Get Contact Email History

    Get the campaign history for one email address. Returns the campaigns sent to the address and its opens, clicks and bounces in Response.Data. Use it to see one subscriber's engagement.

    Inputs

    emailstringrequired
    Email address of the contact. Example: jane@example.com.
    order_bystring
    Field to sort by. Example: date.
    page_numberinteger
    Page number to return, starting at 1. Example: 1.
    page_sizeinteger
    Number of records per page. Example: 25.
    sort_orderstring
    Sort direction: asc or desc. Example: desc.one of ascdesc
  • benchmarkemail_contact_import_status_getGet the status of recent contact imports.Read-only

    Get Contact Import Status

    Get the status of recent contact imports. Returns each import's type, list IDs, contacts found and contacts added in Response.Data. Use it after benchmarkemail_contacts_bulk_add to check progress.

    Inputs

    This tool takes no inputs.