Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to ZeroBounce

Scalekit connector
Open markdown

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

Tools
24
What they doRead · write · destructive
12 · 7 · 512 read7 write5 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 ZeroBounce connection

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

    Each user opens the link once and enters their ZeroBounce 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
  • zerobounce_api_usage_getGet API validation usage between two dates.Read-only

    Get API Usage

    Get API validation usage between two dates. Returns total calls, counts per status (status_valid, status_invalid, status_catch_all and others) and per sub_status, plus the start_date and end_date. Use zerobounce_api_usage_get for usage history. Use zerobounce_credits_get for the current balance. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.

    Inputs

    end_datestringrequired
    Last day of the range, format yyyy-mm-dd. Example: 2026-01-31.
    start_datestringrequired
    First day of the range, format yyyy-mm-dd. Example: 2026-01-01.
  • zerobounce_credits_getGet the account's remaining validation credit balance.Read-only

    Get Credit Balance

    Get the account's remaining validation credit balance. Returns Credits, the number of credits left, or -1 when the API key is invalid. Use zerobounce_credits_get before a large job. Use zerobounce_api_usage_get for usage over a date range.

    Inputs

    This tool takes no inputs.

  • zerobounce_domain_search_file_status_getGet the processing status of a bulk Domain Search file.Read-only

    Get Domain Search File Status

    Get the processing status of a bulk Domain Search file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_domain_search_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.

    Inputs

    file_idstringrequired
    ID of the bulk Domain Search file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
  • zerobounce_email_finder_file_status_getGet the processing status of a bulk Email Finder file.Read-only

    Get Email Finder File Status

    Get the processing status of a bulk Email Finder file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_email_finder_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.

    Inputs

    file_idstringrequired
    ID of the bulk Email Finder file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
  • zerobounce_filters_listList the account's custom allow and block rules.Read-only

    List Allow and Block Filters

    List the account's custom allow and block rules. Returns a JSON array of rules, each with rule (allow or block), target (email, domain, mx or tld) and value. Use zerobounce_filters_list to review rules; add or remove them in the ZeroBounce dashboard.

    Inputs

    This tool takes no inputs.

  • zerobounce_inbox_placement_providers_listList the mailbox and gateway seed providers available for new inbox placement tests.Read-only

    List Inbox Placement Providers

    List the mailbox and gateway seed providers available for new inbox placement tests. Returns emailProviders.items and gatewayProviders.items, each provider with id, name, location, seedCount and seedIds. Use zerobounce_inbox_placement_providers_list to pick provider_ids, seed_ids or providers for zerobounce_inbox_placement_test_create.

    Inputs

    This tool takes no inputs.

  • zerobounce_inbox_placement_test_getGet one inbox placement test with its placement results.Read-only

    Get Inbox Placement Test

    Get one inbox placement test with its placement results. Returns status (running or finished), inboxCount, spamCount, otherCount, notDeliveredCount, pendingCount, percentages, results and seeds, the per-seed placement. Use zerobounce_inbox_placement_test_get to poll a test until status is finished. Use zerobounce_inbox_placement_tests_list to find test IDs.

    Inputs

    test_idstringrequired
    ID of the inbox placement test, from zerobounce_inbox_placement_test_create or zerobounce_inbox_placement_tests_list. Example: 123.
  • zerobounce_inbox_placement_test_types_listList the supported inbox placement test types and the default.Read-only

    List Inbox Placement Test Types

    List the supported inbox placement test types and the default. Returns each type's value and name (1 Email, 2 Unique ID, 3 Auto Alias) and the default type. Use zerobounce_inbox_placement_test_types_list before zerobounce_inbox_placement_test_create when you need the test_type values.

    Inputs

    This tool takes no inputs.