Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to GoSquared

Scalekit connector
Open markdown

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

Tools
54
What they doRead · write · destructive
45 · 7 · 245 read7 write2 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 GoSquared connection

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

    Each user opens the link once and enters their GoSquared 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
  • gosquared_archived_chats_listList archived chat conversations.Read-only

    List Archived Chats

    List archived chat conversations. Returns chats with id and timestamps. Use this for past conversations.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    fromstring
    Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
    limitstring
    Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
    tostring
    End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
  • gosquared_blocked_listList the project's blocked IPs, visitors and bot setting.Read-only

    List Blocked Items

    List the project's blocked IPs, visitors and bot setting. Returns blocked ips, visitors and bots. Use this to audit tracking exclusions.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    presenterstring
    Response shape. Example: plain.one of plaintagsindexedTags
  • gosquared_chat_getGet one chat conversation.Read-only

    Get Chat

    Get one chat conversation. Returns the chat with person, status and last activity. Use this when you know the chat ID.

    Inputs

    chat_idstringrequired
    Chat ID (the client's person ID). Example: email:jane@example.com.
    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
  • gosquared_chat_messages_listList the messages of a chat.Read-only

    List Chat Messages

    List the messages of a chat. Returns messages with id, content, from (agent, client, bot) and timestamp. Use this to read a conversation.

    Inputs

    chat_idstringrequired
    Chat ID (the client's person ID). Example: email:jane@example.com.
    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    fromstring
    Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
    limitstring
    Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
    tostring
    End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
  • gosquared_chats_listList active chat conversations.Read-only

    List Active Chats

    List active chat conversations. Returns chats with id (person ID), last message and timestamps. Use this to find open conversations. Use gosquared_archived_chats_list for archived ones.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    fromstring
    Start date-time of the range (ISO 8601 or relative such as -7d). Example: 2026-01-01.
    limitstring
    Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
    tostring
    End date-time of the range (ISO 8601 or now). Example: 2026-01-31.
  • gosquared_devices_listList all devices seen in People.Read-only

    List Devices

    List all devices seen in People. Returns devices with id, browser, OS and person. Use gosquared_person_devices_list for one person.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    limitstring
    Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
  • gosquared_event_types_listList the event names tracked in People.Read-only

    List Event Types

    List the event names tracked in People. Returns event types with name and counts. Use this to build event filters.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
  • gosquared_now_browsers_listList the browsers of visitors on the site right now.Read-only

    List Live Browsers

    List the browsers of visitors on the site right now. Returns browsers with visitor counts. Use this for a live breakdown.

    Inputs

    site_tokenstringrequired
    The project's site token (GSN-...), from Settings > Current Project > General in GoSquared. Example: GSN-106863-S.
    limitstring
    Maximum results, or offset,count (e.g. 5,10). Example: 0,10.
    presenterstring
    Response shape. Example: plain.one of plainkeyed