Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Litmus

Scalekit connector
Open markdown

The Litmus connector lets your AI agent work with Litmus. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 67 tools.

Tools
67
What they doRead · write · destructive
40 · 24 · 340 read24 write3 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 Litmus connection

    In AgentKit > Connections, create a Litmus connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • litmus_accessibility_check_getGet the results of accessibility checks on an email.Read-only

    Get Accessibility Check Results

    Get the results of accessibility checks on an email. Returns meta.state (pending or complete) and, when complete, the number of checks, the passes and the failures with rule, description, standards (for example WCAG 2AA), impact and the offending HTML snippets. Use litmus_accessibility_check_get to poll after litmus_accessibility_check_create. Polling while pending does not count against the rate limit. Uses the OAuth connection (Litmus v3 API, early access).

    Inputs

    email_guidstringrequired
    GUID returned by litmus_accessibility_check_create. Example: 5c0e3f6a-0b8e-4d0f-9c55-2f1b8a7d9e10.
  • litmus_analytics_activity_report_getGet the activity report (opens over time) for an Email Analytics campaign.Read-only

    Get Campaign Activity Report

    Get the activity report (opens over time) for an Email Analytics campaign. Returns activity report (opens over time) built from the campaign's tracking pixel opens. Use litmus_analytics_activity_report_get to see when opens happened. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidstringrequired
    GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
  • litmus_analytics_activity_summary_report_getGet the activity summary (totals, uniques and first and last opens) for an Email Analytics campaign.Read-only

    Get Campaign Activity Summary

    Get the activity summary (totals, uniques and first and last opens) for an Email Analytics campaign. Returns activity summary (totals, uniques and first and last opens) built from the campaign's tracking pixel opens. Use litmus_analytics_activity_summary_report_get for headline numbers. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidstringrequired
    GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
  • litmus_analytics_browser_usage_report_getGet the browser usage for webmail opens for an Email Analytics campaign.Read-only

    Get Campaign Browser Usage

    Get the browser usage for webmail opens for an Email Analytics campaign. Returns browser usage for webmail opens built from the campaign's tracking pixel opens. Use litmus_analytics_browser_usage_report_get to see which browsers webmail readers use. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidstringrequired
    GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
  • litmus_analytics_campaigns_compareCompare key metrics across a set of campaigns.Read-only

    Compare Analytics Campaigns

    Compare key metrics across a set of campaigns. Returns a comparable report with opens, engagement and client shares per campaign. Use litmus_analytics_campaigns_compare to benchmark campaigns against each other. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidsarrayrequired
    Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
  • litmus_analytics_campaigns_getGet campaign details for a set of campaign GUIDs.Read-only

    Get Analytics Campaigns

    Get campaign details for a set of campaign GUIDs. Returns each campaign's name, status, dates, expiry, open totals and tracking code. Use litmus_analytics_campaigns_get for campaign details. Use the report tools for breakdowns. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidsarrayrequired
    Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
  • litmus_analytics_detailed_engagement_report_getGet the detailed engagement report (engagement by reading-time bucket) for an Email Analytics campaign.Read-only

    Get Campaign Detailed Engagement Report

    Get the detailed engagement report (engagement by reading-time bucket) for an Email Analytics campaign. Returns detailed engagement report (engagement by reading-time bucket) built from the campaign's tracking pixel opens. Use litmus_analytics_detailed_engagement_report_get for reading-time detail. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidstringrequired
    GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
  • litmus_analytics_detailed_mail_client_engagement_report_getGet the detailed engagement per email client for an Email Analytics campaign.Read-only

    Get Campaign Detailed Mail Client Engagement

    Get the detailed engagement per email client for an Email Analytics campaign. Returns detailed engagement per email client built from the campaign's tracking pixel opens. Use litmus_analytics_detailed_mail_client_engagement_report_get for per-client reading-time detail. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.

    Inputs

    guidstringrequired
    GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.