Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Sendspark

Scalekit connector
Open markdown

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

Tools
20
What they doRead · write · destructive
10 · 9 · 110 read9 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 Sendspark connection

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

    Each user opens the link once and enters their Sendspark 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
  • sendspark_campaign_transcript_getGet the transcript of a campaign video as JSON, WebVTT or SubRip.Read-only

    Get Video Transcript

    Get the transcript of a campaign video as JSON, WebVTT or SubRip. Reading never starts a transcription and costs nothing. Returns the transcript (JSON segments, or subtitle text for vtt/srt); 404 when it is not ready. Use sendspark_campaign_transcript_status_get first to check it is ready.

    Inputs

    campaign_idstringrequired
    Campaign (video) ID whose transcript you want. Example: 66c3d4e5f60718293a4b5c6d.
    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
    formatstring
    Output: json (default), vtt or srt. Example: json.one of jsonvttsrt
  • sendspark_campaign_transcript_status_getCheck whether a campaign video has a transcript and whether it is ready.Read-only

    Get Transcript Status

    Check whether a campaign video has a transcript and whether it is ready. Safe to poll; it never starts a transcription. Returns the transcript status, or none when the video never had one. Use this before sendspark_campaign_transcript_get.

    Inputs

    campaign_idstringrequired
    Campaign (video) ID. Example: 66c3d4e5f60718293a4b5c6d.
    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
  • sendspark_dynamic_campaign_getGet one dynamic video campaign with its settings, video and prospects summary.Read-only

    Get Dynamic Video Campaign

    Get one dynamic video campaign with its settings, video and prospects summary. Returns the campaign's ID, name, status, video, page settings and prospects. Use sendspark_dynamic_campaigns_list to find IDs.

    Inputs

    campaign_idstringrequired
    Dynamic video campaign ID. Get it from sendspark_dynamic_campaigns_list or the create response. Example: 64a1b2c3d4e5f60718293a4b.
    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
  • sendspark_dynamic_campaigns_listList the dynamic (AI-personalized) video campaigns in a workspace, with search, sorting and paging.Read-only

    List Dynamic Video Campaigns

    List the dynamic (AI-personalized) video campaigns in a workspace, with search, sorting and paging. Returns campaigns with ID, name, status, video settings and prospect counts. Use this to find a campaign_id. Use sendspark_dynamic_campaign_get for one campaign.

    Inputs

    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
    limitinteger
    Campaigns to return. Example: 20.
    offsetinteger
    Campaigns to skip for paging. Example: 0.
    projection_typestring
    How much detail to return. Example: DEFAULT.one of DEFAULTDETAILEDMINIMAL
    prospect_onlyboolean
    Only campaigns that have prospects. Example: false.
    searchstring
    Search text on the campaign name. Example: Q4 outreach.
    sort_orderstring
    Sort direction. Example: desc.one of ascdesc
  • sendspark_dynamics_settings_getGet the workspace-wide settings for dynamic video campaigns.Read-only

    Get Dynamic Video Settings

    Get the workspace-wide settings for dynamic video campaigns. Returns the dynamic video settings, such as fallback data behaviour. Use sendspark_dynamic_campaign_settings_update to change a campaign's settings.

    Inputs

    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
  • sendspark_prospect_getGet a prospect in a dynamic video campaign by email, including their personalized video status and links.Read-only

    Get Prospect

    Get a prospect in a dynamic video campaign by email, including their personalized video status and links. Returns the prospect's fields, video status and share link, plus emailEmbedHTML or fields when requested. Use this after sendspark_prospect_add to get the video link.

    Inputs

    campaign_idstringrequired
    Dynamic video campaign ID. Get it from sendspark_dynamic_campaigns_list or the create response. Example: 64a1b2c3d4e5f60718293a4b.
    contact_emailstringrequired
    Prospect's email address. Example: jane@acme.com.
    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
    includestring
    Comma-separated extra fields: emailEmbedHTML, fields. Example: emailEmbedHTML,fields.
  • sendspark_webhook_getGet one Sendspark webhook.Read-only

    Get Webhook

    Get one Sendspark webhook. Returns its ID, name, URL, module, events, identifiers and enabled state. Use sendspark_webhooks_list to find IDs.

    Inputs

    webhook_idstringrequired
    Webhook ID from sendspark_webhooks_list. Example: 65b2c3d4e5f60718293a4b5c.
    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.
  • sendspark_webhooks_listList the webhooks in a Sendspark workspace.Read-only

    List Webhooks

    List the webhooks in a Sendspark workspace. Returns each webhook's ID, name, URL, module, events and enabled state. Use this to find a webhook_id.

    Inputs

    workspace_idstringrequired
    Sendspark workspace ID. Get it from sendspark_workspace_id_get (the workspace of your API key) or sendspark_workspaces_list. Example: 63f6a4145a5e755e2e8fe19d.