Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to GlockApps

Scalekit connector
Open markdown

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

Tools
48
What they doRead · write · destructive
26 · 16 · 626 read16 write6 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 GlockApps connection

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

    Each user opens the link once and enters their GlockApps 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
  • glockapps_account_balance_getGet the account's spam test credit balance.Read-only

    Get Spam Test Credit Balance

    Get the account's spam test credit balance. Returns testCredits with balance, the credits left to spend, and planCredits, the credits the plan includes each period. Use glockapps_account_balance_get before glockapps_manual_test_create or activating automatic tests, which spend one credit per run.

    Inputs

    This tool takes no inputs.

  • glockapps_autotest_getGet one automatic test's settings.Read-only

    Get Automatic Test

    Get one automatic test's settings. Returns its schedule, letter, connected mailbox, provider groups, send settings, folder, note and active status. Use glockapps_autotest_get before glockapps_autotest_update, which replaces every field. Use glockapps_autotest_results_list for its results.

    Inputs

    autotest_idstringrequired
    ID of the automatic test, from glockapps_autotests_short_list. Example: 6549fe4bf1d552cbdb5ef3a3.
    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
  • glockapps_autotest_results_listList the test results produced by an automatic test's runs.Read-only

    List Automatic Test Results

    List the test results produced by an automatic test's runs. Returns one report per run with inbox, spam and missing placement, filter scores and authentication results. Use glockapps_autotest_results_list to track an autotest's placement over time. Use glockapps_test_report_get for one run's full report. Use page and limit to page through results.

    Inputs

    autotest_idstringrequired
    ID of the automatic test, from glockapps_autotests_short_list. Example: 6549fe4bf1d552cbdb5ef3a3.
    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
    hide_failedboolean
    a boolean flag, if set to true, it will hide failed tests; the default value is false. Example: true.
    limitstring
    Number of results per page. Example: 10.
    pagestring
    Page number, starting at 1 (default 1). Example: 1.
    sort_fieldstring
    name of the autotest result field to sort by, default is "created" of the test result. Example: created.
    sort_valueinteger
    Sort order: 1 for ascending, -1 for descending. Example: -1.
  • glockapps_autotests_listList a project's automatic (scheduled) tests with their full settings.Read-only

    List Automatic Tests

    List a project's automatic (scheduled) tests with their full settings. Returns autotests with schedule, letter, connected mailbox, provider groups, folder and active status. Use glockapps_autotests_list for full settings. Use glockapps_autotests_short_list for a lighter list. Use page and limit to page through results.

    Inputs

    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
    activeboolean
    allows to filter autotests based on the active status of the autotest: if set to "true", get active autotests; if set to "false", get inactive autotests. Example: true.
    folder_idstring
    folder ID, allow to filter tests by folder ID. Example: 64aff26141383479c220a619.
    limitstring
    Number of results per page. Example: 50.
    pagestring
    Page number, starting at 1 (default 1). Example: 1.
    search_textstring
    search text, allows to filter autotests based on the search text found in the autotests notes and also in the report note, report testId, report letter subject and fromEmail. Example: newsletter.
    sending_account_idstring
    ID of the connected mailbox, from glockapps_connected_mailboxes_list. Example: 6650c1f2a1b2c3d4e5f60718.
    sort_fieldarray
    name of the response field to sort by, default is ID of the autotest. Example: ["created"].
    sort_valuearray
    Sort order: 1 for ascending, -1 for descending. Example: [-1].
  • glockapps_autotests_short_listList a project's automatic tests in short form.Read-only

    List Automatic Tests (Short)

    List a project's automatic tests in short form. Returns each autotest's ID, note, schedule, active status and folder. Use glockapps_autotests_short_list to find autotest IDs. Use glockapps_autotest_get for one autotest's full settings. Use page and limit to page through results.

    Inputs

    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
    activeboolean
    allows to filter autotests based on the active status of the autotest: if set to "true", get active autotests; if set to "false", get inactive autotests. Example: true.
    folder_idstring
    folder ID, allow to filter tests by folder ID. Example: 64aff26141383479c220a619.
    limitstring
    Number of results per page. Example: 50.
    pagestring
    Page number, starting at 1 (default 1). Example: 1.
    search_textstring
    search text, allows to filter autotests based on the search text found in the autotests notes and also in the report note, report testId, report letter subject and fromEmail. Example: newsletter.
    sending_account_idstring
    ID of the connected mailbox, from glockapps_connected_mailboxes_list. Example: 6650c1f2a1b2c3d4e5f60718.
    sort_fieldarray
    name of the response field to sort by, default is ID of the autotest. Example: ["created"].
    sort_valuearray
    Sort order: 1 for ascending, -1 for descending. Example: [-1].
  • glockapps_blocklist_servers_listList the blocklist (DNSBL) servers GlockApps checks sending IPs and domains against.Read-only

    List Blocklist Servers

    List the blocklist (DNSBL) servers GlockApps checks sending IPs and domains against. Returns the blocklist servers with their IDs and names. Use glockapps_blocklist_servers_list to pick blocklistIds for glockapps_project_create or glockapps_project_update. Use page and limit to page through results.

    Inputs

    limitstring
    Number of results per page. Example: 100.
    pagestring
    Page number, starting at 1 (default 1). Example: 1.
  • glockapps_connected_mailbox_getGet one connected mailbox.Read-only

    Get Connected Mailbox

    Get one connected mailbox. Returns its type, name, sender, proxy email, header settings and provider groups. Use glockapps_connected_mailbox_get for one mailbox. Use glockapps_connected_mailboxes_list to find IDs.

    Inputs

    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
    sending_account_idstringrequired
    ID of the connected mailbox, from glockapps_connected_mailboxes_list. Example: 6650c1f2a1b2c3d4e5f60718.
  • glockapps_connected_mailboxes_listList a project's connected mailboxes (SMTP, Google, Microsoft, Klaviyo or HubSpot accounts GlockApps can send tests from).Read-only

    List Connected Mailboxes

    List a project's connected mailboxes (SMTP, Google, Microsoft, Klaviyo or HubSpot accounts GlockApps can send tests from). Returns mailboxes with their ID, name, type, sender address, proxy email and provider groups. Use glockapps_connected_mailboxes_list to find a sendingAccountId for glockapps_manual_test_send or glockapps_autotest_create. Use page and limit to page through results.

    Inputs

    project_idstringrequired
    ID of the GlockApps project, from glockapps_projects_list. Example: 123456.
    idsstring
    Comma-separated connected mailbox IDs to filter by. Example: 6650c1f2a1b2c3d4e5f60718.
    limitstring
    Number of results per page. Example: 50.
    pagestring
    Page number, starting at 1 (default 1). Example: 1.
    search_regexstring
    Search regular expression to filter connected mailboxes. Example: ^news.
    search_textstring
    Search text to filter connected mailboxes. Example: newsletter.
    sort_fieldstring
    Field name to sort by. Example: created.
    sort_valueinteger
    Sort order: 1 for ascending, -1 for descending. Example: -1.
    typestring
    Optional connected mailbox type filter. Omit to return all types. Example: SMTP.one of SMTPMicrosoftGoogleKlaviyoHubSpot