Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to BigMailer

Scalekit connector
Open markdown

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

Tools
59
What they doRead · write · destructive
29 · 24 · 629 read24 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 BigMailer connection

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

    Each user opens the link once and enters their BigMailer 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
  • bigmailer_brand_getGet one brand by ID.Read-only

    Get Brand

    Get one brand by ID. Returns the brand's name, default sender, time zone, bounce settings and limits.

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
  • bigmailer_brand_properties_listList brand properties: reusable values (such as an address or logo HTML) inserted with merge tags.Read-only

    List Brand Properties

    List brand properties: reusable values (such as an address or logo HTML) inserted with merge tags. Returns each property's ID, name, merge tag and value.

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    cursorstring
    Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
    limitinteger
    Maximum number of items to return (up to 100). Example: 25.
  • bigmailer_brands_listList the brands in the BigMailer account.Read-only

    List Brands

    List the brands in the BigMailer account. Returns each brand's ID, name, sender defaults and contact counts. Use the brand ID with every other tool.

    Inputs

    cursorstring
    Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
    limitinteger
    Maximum number of items to return (up to 100). Example: 25.
  • bigmailer_bulk_campaign_getGet one bulk campaign.Read-only

    Get Bulk Campaign

    Get one bulk campaign. Returns its content, audience, status, schedule and stats (sent, opens, clicks, bounces, unsubscribes).

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    campaign_idstringrequired
    ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
  • bigmailer_bulk_campaign_url_clicks_listList link clicks for a bulk campaign.Read-only

    List Bulk Campaign Link Clicks

    List link clicks for a bulk campaign. Returns each URL with its click counts.

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    campaign_idstringrequired
    ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    pageinteger
    Page number, starting at 1. Example: 1.
    per_pageinteger
    Items per page. Example: 50.
  • bigmailer_bulk_campaigns_listList bulk (newsletter) campaigns, with cursor paging.Read-only

    List Bulk Campaigns

    List bulk (newsletter) campaigns, with cursor paging. Returns each campaign's ID, name, subject, status, schedule and stats.

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    cursorstring
    Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
    limitinteger
    Maximum number of items to return (up to 100). Example: 25.
  • bigmailer_connections_listList the sending connections (Amazon SES accounts) linked to BigMailer.Read-only

    List Connections

    List the sending connections (Amazon SES accounts) linked to BigMailer. Returns each connection's ID, type and status.

    Inputs

    cursorstring
    Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
    limitinteger
    Maximum number of items to return (up to 100). Example: 25.
  • bigmailer_contact_getGet one contact by ID or email address.Read-only

    Get Contact

    Get one contact by ID or email address. Returns the contact's email, field values, lists and unsubscribe settings.

    Inputs

    brand_idstringrequired
    ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
    contact_idstringrequired
    ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.