Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to NeverBounce

Scalekit connector
Open markdown

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

Tools
10
What they doRead · write · destructive
5 · 4 · 15 read4 write1 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 NeverBounce connection

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

    Each user opens the link once and enters their NeverBounce 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
  • neverbounce_account_info_getGet the NeverBounce account's remaining credits and bulk job counts.Read-only

    Get Account Info

    Get the NeverBounce account's remaining credits and bulk job counts. Returns credits_info (paid and free credits used and remaining) and job_counts (completed, under_review, queued, processing). Use neverbounce_account_info_get to check the credit balance before a verification or bulk job. Use neverbounce_jobs_search to list the jobs themselves.

    Inputs

    This tool takes no inputs.

  • neverbounce_job_results_listList the verified rows of a completed bulk job, one page at a time.Read-only

    List Bulk Job Results

    List the verified rows of a completed bulk job, one page at a time. Returns total_results, total_pages, the query used, and results, each with the original data row and a verification object (result, flags, suggested_correction, address_info). Use neverbounce_job_results_list to read per-address results. Use neverbounce_job_status_get for counts only. Requires a complete job; check job_status with neverbounce_job_status_get first.

    Inputs

    job_idintegerrequired
    Numeric ID of the bulk verification job to read results for, as returned by neverbounce_job_create or neverbounce_jobs_search. Example: 289022.
    items_per_pageinteger
    Rows per page, 1 to 1000. Defaults to 10. Example: 100.
    pageinteger
    Page number to return, starting at 1. Defaults to 1. Example: 2.
  • neverbounce_job_status_getGet the status and counts of one bulk verification job.Read-only

    Get Bulk Job Status

    Get the status and counts of one bulk verification job. Returns id, job_status (such as uploading, parsing, waiting, queued, running, complete, under_review or failed), filename, created_at, started_at, finished_at, total counts by result, bounce_estimate, percent_complete and failure_reason. Use neverbounce_job_status_get to poll one known job. Use neverbounce_jobs_search to find jobs by filename or status. Use neverbounce_job_results_list to read verified rows once the job is complete.

    Inputs

    job_idintegerrequired
    Numeric ID of the bulk verification job to check, as returned by neverbounce_job_create or neverbounce_jobs_search. Example: 289022.
  • neverbounce_poe_confirmConfirm on the server that an email submitted through a form was the one the NeverBounce JavaScript widget verified (proof of entry).Read-only

    Confirm Widget Verification

    Confirm on the server that an email submitted through a form was the one the NeverBounce JavaScript widget verified (proof of entry). Returns status and token_confirmed (true when the email, transaction and token match). Use neverbounce_poe_confirm to guard against tampering with the client-side widget. Use neverbounce_email_verify to verify an address from the server instead. Requires the transaction ID, confirmation token and result that the widget added to the submitted form.

    Inputs

    confirmation_tokenstringrequired
    The confirmation token the widget added to the form, in the nb-confirmation-token field. Example: e3173fdbbdce6bad26522dae792911f2.
    emailstringrequired
    The email address that was submitted with the form. Example: support@neverbounce.com.
    resultstringrequired
    The verification result the widget reported for the address. Example: valid.one of validinvaliddisposablecatchallunknown
    transaction_idstringrequired
    The transaction ID the widget added to the form, in the nb-transaction-id field. Example: NBPOE-TXN-5942940c09669.
  • neverbounce_email_verifyVerify one email address in real time and spend one NeverBounce verification credit.Write

    Verify Email

    Verify one email address in real time and spend one NeverBounce verification credit. Returns result (valid, invalid, disposable, catchall or unknown), flags such as has_dns_mx, role_account or free_email_host, suggested_correction and execution_time, plus address_info and credits_info when requested. Use neverbounce_email_verify for one address at a time, such as at sign-up. Use neverbounce_job_create to verify a list. Verification can take several seconds for slow mail servers: keep timeout at 8 seconds or less so the call finishes inside the tool-call time limit.

    • Idempotent

    Inputs

    emailstringrequired
    The email address to verify. Example: support@neverbounce.com.
    address_infointeger
    Set to 1 to add an address_info object that splits the address into normalized email, user, alias, host, domain, subdomain and TLD. Defaults to 0. Example: 1.one of 01
    credits_infointeger
    Set to 1 to add a credits_info object with the paid and free credits used by this call and the credits remaining. Defaults to 0. Example: 1.one of 01
    leverage_historical_datainteger
    Set to 0 to stop NeverBounce from using its historical verification data for this address and force a fresh check. NeverBounce uses historical data by default (1). Example: 0.one of 01
    timeoutinteger
    Longest time in seconds NeverBounce should try to verify before it gives up and returns unknown. Network time is extra. Use 8 or less to stay within the tool-call time limit. Example: 8.
  • neverbounce_job_createCreate a bulk verification job from a list of email records or from a file at a remote URL.Write

    Create Bulk Job

    Create a bulk verification job from a list of email records or from a file at a remote URL. Returns job_id. Verification results are not in the response; the job runs in the background. Use neverbounce_job_create to verify many addresses at once. Use neverbounce_email_verify for a single address. With auto_start set, credits are spent as soon as parsing ends; otherwise call neverbounce_job_parse and neverbounce_job_start, then poll neverbounce_job_status_get and read rows with neverbounce_job_results_list.

    Inputs

    allow_manual_reviewboolean
    Set true to let NeverBounce place the job in manual review. API jobs are not eligible by default. Example: false.
    auto_parseboolean
    Set true to start indexing the list as soon as the job is created. When false or omitted, call neverbounce_job_parse next. Example: true.
    auto_startboolean
    Set true to start verification as soon as parsing ends. This deducts credits and cannot be stopped. When false or omitted, call neverbounce_job_start next. Example: false.
    callback_headersobject
    Extra request headers to send with each callback to callback_url, as header-name to value pairs. Example: {"X-Callback-Token": "s3cr3t"}.
    callback_urlstring
    URL that NeverBounce sends a POST with job_id and event to as the job changes state, such as job_parsed, job_completed or job_failed. Example: https://example.com/neverbounce/callback.
    emailsarray
    The records to verify, when you supply the data directly. Each record is an object holding an email key plus any other columns you want kept with it, such as an ID or a name; object keys become column headers. A record can instead be an array of column values, which leaves out headers. Provide this or remote_url, not both. The whole request must stay under 25 MB. Example: [{"id": 12345, "email": "support@neverbounce.com", "name": "Fred McValid"}].
    filenamestring
    Name shown for the job in the NeverBounce dashboard and used to find it with neverbounce_jobs_search. Example: signups-2026-11.csv.
    leverage_historical_databoolean
    Set false to stop NeverBounce from using its historical verification data and force fresh checks for the whole list. NeverBounce uses historical data by default. Example: false.
    remote_urlstring
    Direct link to a hosted file to verify instead of supplied records: a CSV file or one email per line. HTTP, HTTPS and FTP links work; put any username and password in the URL. Provide this or emails, not both. Example: https://example.com/full/path/to/file.csv.
    run_sampleboolean
    Set true to run a free sample of the list that returns an estimated bounce rate instead of verifying every address. Start the full run afterwards with neverbounce_job_start. Example: true.
  • neverbounce_job_parseParse (index) a bulk job that was created without auto_parse.Write

    Parse Bulk Job

    Parse (index) a bulk job that was created without auto_parse. Returns queue_id. A list can be parsed only once. Use neverbounce_job_parse after neverbounce_job_create when auto_parse was off. Use neverbounce_job_start afterwards when auto_start is off. Requires a job_id from neverbounce_job_create.

    Inputs

    job_idintegerrequired
    Numeric ID of the bulk verification job to parse, as returned by neverbounce_job_create or neverbounce_jobs_search. Example: 289022.
    auto_startboolean
    Set true to start verification, and spend credits, as soon as parsing ends. Defaults to false. Example: true.