Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Iterable

Scalekit connector
Open markdown

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

Tools
62
What they doRead · write · destructive
22 · 30 · 1022 read30 write10 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 Iterable connection

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

    Each user opens the link once and enters their Iterable 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
  • iterable_campaign_getGet a campaign by ID.Read-only

    Get a campaign

    Get a campaign by ID. Rate limit: 100 requests/second, per project. Returns an object with campaignState, createdAt, createdByUserId, endedAt, id, labelIds, labels, listIds, messageMedium, name, recurringCampaignId, sendSize and more. Use this when you have the ID. Use iterable_campaigns_list to find one. Needs id from iterable_campaigns_list.

    Inputs

    idintegerrequired
    Campaign ID. Example: 12345
  • iterable_campaigns_listGet metadata about campaigns in a project.Read-only

    List campaign metadata

    Get metadata about campaigns in a project. Use page and pageSize parameters to paginate results. Returns an object with campaigns, nextPageUrl, previousPageUrl, totalCampaignsCount. Use this to browse. Use iterable_campaign_get when you already have the ID.

    Inputs

    campaignStatearray
    Filter campaigns by state. Can be specified multiple times to filter by multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived. Example: ?campaignState=Ready&campaignState=Running
    pageinteger
    Page number (starting at 1). Example: 1
    pageSizeinteger
    Number of results to return per page (defaults to 20, maximum of 1000). Example: 10
    sortstring
    Field to sort campaigns by, with optional direction prefix. Use - for descending, + or no prefix for ascending. Campaigns can be sorted by id, name, createdAt, updatedAt, or startAt. Examples: -createdAt, +name, id
  • iterable_catalog_field_mappings_getField mappings (field to data types) and undefined fields of a catalog Returns an object with definedMappings, undefinedFields.Read-only

    Get field mappings for a catalog

    Field mappings (field to data types) and undefined fields of a catalog Returns an object with definedMappings, undefinedFields. Needs catalogName from iterable_catalogs_list.

    Inputs

    catalogNamestringrequired
    Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
  • iterable_catalog_item_getGet a specific catalog item from the given catalog.Read-only

    Get a specific catalog item

    Get a specific catalog item from the given catalog. Returns an object with catalogName, itemId, lastModified, size, value. Use this when you have the ID. Use iterable_catalog_items_list to find one. Needs catalogName from iterable_catalogs_list; itemId from iterable_catalog_items_list.

    Inputs

    catalogNamestringrequired
    Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
    itemIdstringrequired
    Catalog item id [Alphanumeric, dashes, case sensitive, 255 characters max]. Example: sku-1
  • iterable_catalog_items_listGet the catalog items for a catalog.Read-only

    Get the catalog items for a catalog

    Get the catalog items for a catalog. Rate limit: 100 requests/second, per API key. Returns an object with catalogItemsWithProperties, nextPageUrl, previousPageUrl, totalItemsCount. Use this to browse. Use iterable_catalog_item_get when you already have the ID. Needs catalogName from iterable_catalogs_list.

    Inputs

    catalogNamestringrequired
    Catalog name [Alphanumeric, dashes, case insensitive, 255 characters max]. Example: products
    orderBystring
    Field by which results should be ordered. To also use the sortAscending parameter, this field must have a defined type. Example: itemId
    pageinteger
    Page number to list (starting at 1). Example: 1
    pageSizeinteger
    Number of results to display per page (defaults to 10). Example: 10
    sortAscendingboolean
    Sort results by ascending (Defaults to false). Example: false
  • iterable_catalogs_listGet catalog names.Read-only

    Get catalog names

    Get catalog names. Rate limit: 100 requests/second, per API key. Returns an object with catalogNames, nextPageUrl, previousPageUrl, totalCatalogsCount.

    Inputs

    pageinteger
    Page number to list (starting at 1). Example: 1
    pageSizeinteger
    Number of results to display per page (defaults to 10). Example: 10
  • iterable_channels_listGet all message channels within the project.Read-only

    Get channels

    Get all message channels within the project. Rate limit: 100 requests/second, per project. Returns channels, an array of items with channelType, id, messageMedium, name.

    Inputs

    This tool takes no inputs.

  • iterable_email_template_getGet an email template by templateId, including subject, HTML, sender details and data feed settings.Read-only

    Get an email template by templateId

    Get an email template by templateId, including subject, HTML, sender details and data feed settings. Returns an object with bccEmails, cacheDataFeed, campaignDataFields, ccEmails, clientTemplateId, creatorUserId, dataFeedId, dataFeedIds, fromEmail, fromName, googleAnalyticsCampaignName, html and more.

    Inputs

    templateIdintegerrequired
    Template ID. Example: 12345
    localestring
    Locale of content to get. Example: en-US