Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Fluxguard

Scalekit connector
Open markdown

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

Tools
12
What they doRead · write · destructive
5 · 4 · 35 read4 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 Fluxguard connection

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

    Each user opens the link once and enters their Fluxguard 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
  • fluxguard_account_getGet your Fluxguard organization's account attributes.Read-only

    Get Account

    Get your Fluxguard organization's account attributes. Returns the org's account data as JSON. Use this to confirm the API key works and to see account-level settings.

    Inputs

    This tool takes no inputs.

  • fluxguard_categories_listList all categories in your Fluxguard account.Read-only

    List Categories

    List all categories in your Fluxguard account. Returns an object keyed by category ID with each category's name and whether it is for sites or pages. Use this to find category IDs for fluxguard_page_add.

    Inputs

    This tool takes no inputs.

  • fluxguard_page_getGet the monitoring data for one page, identified by its site, session and page IDs.Read-only

    Get Page

    Get the monitoring data for one page, identified by its site, session and page IDs. Returns the page's data, including its URL and capture and change information. Use this after fluxguard_crawl_start or to review a page added with fluxguard_page_add.

    Inputs

    page_idstringrequired
    Fluxguard page ID, returned by fluxguard_page_add as pageId. Example: k1l2m3n4o5.
    session_idstringrequired
    Fluxguard session ID within the site, returned by fluxguard_page_add as sessionId. Example: f6g7h8i9j0.
    site_idstringrequired
    Fluxguard site ID, returned by fluxguard_page_add as siteId. Example: a1b2c3d4e5.
  • fluxguard_webhook_sample_getGet a sample webhook payload built from your account's data, or from sample data for a new account.Read-only

    Get Sample Webhook

    Get a sample webhook payload built from your account's data, or from sample data for a new account. Returns the JSON body a webhook would receive. Use this to see the payload format before creating a webhook with fluxguard_webhook_create.

    Inputs

    This tool takes no inputs.

  • fluxguard_webhooks_listList the webhooks configured for your Fluxguard organization.Read-only

    List Webhooks

    List the webhooks configured for your Fluxguard organization. Returns each webhook with its ID and URL. Use this to find a webhook ID before deleting it.

    Inputs

    This tool takes no inputs.

  • fluxguard_category_createCreate a new site category with the given name.Write

    Create Site Category

    Create a new site category with the given name. The API can only create site categories. Returns the created category, including its ID. Use the ID in fluxguard_page_add to file new sites under it.

    Inputs

    namestringrequired
    Name of the new site category. Example: Competitors.
  • fluxguard_crawl_startStart a crawl of a monitored session now, so Fluxguard captures its pages and checks them for changes.Write

    Start Crawl

    Start a crawl of a monitored session now, so Fluxguard captures its pages and checks them for changes. Returns the crawl request result. Use this to check for changes outside the session's schedule. Read results with fluxguard_page_get.

    Inputs

    session_idstringrequired
    Fluxguard session ID within the site, returned by fluxguard_page_add as sessionId. Example: f6g7h8i9j0.
    site_idstringrequired
    Fluxguard site ID, returned by fluxguard_page_add as siteId. Example: a1b2c3d4e5.
  • fluxguard_page_addAdd a web page to Fluxguard for change monitoring, either into an existing site and session or into a new site.Write

    Add Page

    Add a web page to Fluxguard for change monitoring, either into an existing site and session or into a new site. Returns the siteId, sessionId and pageId of the added page. Pass site_id and session_id to add to an existing site; otherwise a new site and session are created and the category and nickname options apply.

    Inputs

    urlstringrequired
    URL of the page to monitor. Example: https://example.org/pricing.
    categoriesarray
    For a new site only: IDs of the categories to put the site in. Get IDs from fluxguard_categories_list. Example: ["cat_123", "cat_456"]
    category_idstring
    For a new site only: ID of a single category to put the site in. Example: cat_123.
    category_namestring
    For a new site only: name of a single category to put the site in. Example: Competitors.
    session_idstring
    Existing session (within site_id) to add the page to. Send together with site_id. Example: f6g7h8i9j0.
    site_idstring
    Existing site to add the page to. Send together with session_id; when set, the category and nickname options are ignored. Example: a1b2c3d4e5.
    site_nicknamestring
    For a new site only: nickname for the site. Example: Acme pricing.