Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Brevo

Scalekit connector
Open markdown

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

Tools
65
What they doRead · write · destructive
30 · 26 · 930 read26 write9 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 Brevo connection

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

    Each user opens the link once and enters their Brevo 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
  • brevo_account_getRetrieve the Brevo account's company details, plan and credits.Read-only

    Get Account

    Retrieve the Brevo account's company details, plan and credits. Returns email, firstName, lastName, companyName, address, plan (type, credits, creditsType per channel) and relay (SMTP relay settings).

    Inputs

    This tool takes no inputs.

  • brevo_blocked_contacts_listList contacts blocked or unsubscribed from transactional email (hard bounces, spam complaints, unsubscribes, admin blocks).Read-only

    List Blocked Transactional Contacts

    List contacts blocked or unsubscribed from transactional email (hard bounces, spam complaints, unsubscribes, admin blocks). Returns count and contacts, an array with email, senderEmail, reason (code and message) and blockedAt.

    Inputs

    end_datestring
    Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts. Example: 2026-11-13
    limitinteger
    Number of documents returned per page. Example: 50
    offsetinteger
    Index of the first document on the page. Example: 0
    sendersarray
    Comma separated list of emails of the senders from which contacts are blocked or unsubscribed. Example: ["news@example.com"]
    sortstring
    Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of ascdesc
    start_datestring
    Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts. Example: 2026-11-01
  • brevo_contact_attributes_listList the contact attributes (fields) defined in the account.Read-only

    List Contact Attributes

    List the contact attributes (fields) defined in the account. Returns attributes, an array with name, category (normal, transactional, category, calculated, global), type and enumeration.

    Inputs

    This tool takes no inputs.

  • brevo_contact_campaign_stats_getGet one contact's email campaign activity (messages sent, opened, clicked, bounced, unsubscribed) over up to 90 days.Read-only

    Get Contact Campaign Statistics

    Get one contact's email campaign activity (messages sent, opened, clicked, bounced, unsubscribed) over up to 90 days. Returns messagesSent, opened, clicks, hardBounces, softBounces, complaints, unsubscriptions and delivered, each with campaignId and event time.

    Inputs

    identifierstringrequired
    Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
    end_datestring
    Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days. Example: 2026-11-13
    start_datestring
    Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. Example: 2026-11-01
  • brevo_contact_getRetrieve one contact by email, ID, ext_id or phone.Read-only

    Get Contact

    Retrieve one contact by email, ID, ext_id or phone. Returns id, email, emailBlacklisted, smsBlacklisted, attributes, listIds, listUnsubscribed, createdAt, modifiedAt and statistics.

    Inputs

    identifierstringrequired
    Contact identifier: email address, numeric contact ID, ext_id, phone_id, whatsapp_id or landline_number_id (set identifier_type for the non-email kinds) Example: jane@example.com
    end_datestring
    Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Example: 2026-11-13
    identifier_typestring
    Email_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute. Example: email_idone of email_idphone_idcontact_idext_idwhatsapp_idlandline_number_id
    start_datestring
    Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date. Example: 2026-11-01
  • brevo_contacts_listList contacts, optionally modified or created since a date, in specific lists or segments, or matching attribute filters.Read-only

    List Contacts

    List contacts, optionally modified or created since a date, in specific lists or segments, or matching attribute filters. Returns count and contacts, an array with id, email, emailBlacklisted, smsBlacklisted, attributes, listIds, createdAt and modifiedAt. Use brevo_contact_get for one contact by email or ID.

    Inputs

    created_sincestring
    Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01T00:00:00Z
    filterstring
    Filter contacts by an attribute value with the equals operator, for example equals(FIRSTNAME,"Jane"), equals(B1, true) or equals(COUNTRY,"USA, INDIA"). Multiple-choice options are combined with AND; category attributes match by id or value. Example: equals(FIRSTNAME,"Jane")
    idsarray
    Filter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers. Example: [42]
    limitinteger
    Number of documents per page. Example: 50
    list_idsarray
    Ids of the list. Either listIds or segmentId can be passed. Example: [12]
    modified_sincestring
    Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. Example: 2026-11-01T00:00:00Z
    offsetinteger
    Index of the first document of the page. Example: 0
    segment_idinteger
    Id of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1). Example: 123
    sortstring
    Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Example: descone of ascdesc
  • brevo_domain_getRetrieve a sender domain's DNS records (Brevo code, DKIM, DMARC, SPF) and their status.Read-only

    Get Sender Domain

    Retrieve a sender domain's DNS records (Brevo code, DKIM, DMARC, SPF) and their status. Returns domain, verified, authenticated and dns_records (each with type, value, host_name and status).

    Inputs

    domain_namestringrequired
    Domain name. Example: mail.example.com
  • brevo_domains_listList sender domains with their authentication status.Read-only

    List Sender Domains

    List sender domains with their authentication status. Returns domains, an array with id, domain_name, authenticated, verified and ip.

    Inputs

    This tool takes no inputs.