Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Gupshup

Scalekit connector
Open markdown

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

Tools
15
What they doRead · write · destructive
7 · 8 · 07 read8 write0 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 Gupshup connection

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

    Each user opens the link once and enters their Gupshup 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
  • gupshup_blocked_users_listList the WhatsApp users your Gupshup app's business number has blocked, one page at a time.Read-only

    List Blocked Users

    List the WhatsApp users your Gupshup app's business number has blocked, one page at a time. Returns blocked users with their wa_id and a paging cursor for the next page. Use this to audit blocks. Use gupshup_users_unblock to unblock someone.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
    afterstring
    Cursor for the next page, from the paging.cursors.after value of the previous response. Example: QVFIUmFfZA2ZAW
    limitinteger
    Users per page, up to 100. Defaults to 100. Example: 100
  • gupshup_business_details_getGet the WhatsApp Business account details linked to a Gupshup app.Read-only

    Get Business Details

    Get the WhatsApp Business account details linked to a Gupshup app. Returns business details such as the WABA ID, display name, phone number, verification and messaging limit information. Use this for account-level details. Use gupshup_business_profile_get for the public profile fields customers see.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
  • gupshup_business_profile_about_getGet the About text of a Gupshup app's WhatsApp business profile.Read-only

    Get Business Profile About

    Get the About text of a Gupshup app's WhatsApp business profile. Returns the about message. Use this for the short About line only. Use gupshup_business_profile_get for the rest of the profile.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
  • gupshup_business_profile_getGet the public WhatsApp business profile of a Gupshup app.Read-only

    Get Business Profile

    Get the public WhatsApp business profile of a Gupshup app. Returns the profile address, description, email, vertical and websites. Use this to read the profile customers see. Use gupshup_business_profile_update to change it.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
  • gupshup_business_profile_photo_getGet the link to the profile photo of a Gupshup app's WhatsApp business profile.Read-only

    Get Business Profile Photo

    Get the link to the profile photo of a Gupshup app's WhatsApp business profile. Returns a URL for the current profile photo. Use this to read the photo link. Changing the photo needs a file upload, which this connector does not support.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
  • gupshup_template_getGet one WhatsApp message template of a Gupshup app by its Gupshup template ID.Read-only

    Get Template

    Get one WhatsApp message template of a Gupshup app by its Gupshup template ID. Returns the template with its body, category, language, status, type, buttons and Meta externalId. Use this to check one template's approval status or content. Use gupshup_templates_list to search all templates. Needs template_id from gupshup_templates_list.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
    template_idstringrequired
    Gupshup template ID (the id field from the template list). Example: 312371e9-2771-463b-8cfd-cd8994b810cc
  • gupshup_templates_listList the WhatsApp message templates of a Gupshup app, optionally filtered by status, category, type, quality or language.Read-only

    List Templates

    List the WhatsApp message templates of a Gupshup app, optionally filtered by status, category, type, quality or language. Returns templates with id, elementName, category, languageCode, status, templateType, data (body) and the Meta externalId. Use this to find a template's id before sending. Use gupshup_template_get for one template you already have the ID of.

    Inputs

    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea
    language_codestring
    Only return templates in this language code. Example: en
    page_nointeger
    Zero-based page number. Defaults to 0. Example: 0
    page_sizeinteger
    Templates per page. Defaults to 100. Example: 100
    qualitystring
    Only return templates with this Meta quality rating, for example GREEN, YELLOW, RED or UNKNOWN. Example: GREEN
    template_categorystring
    Only return templates in this category. Example: MARKETINGone of MARKETINGUTILITYAUTHENTICATION
    template_statusstring
    Only return templates with this approval status, for example APPROVED, PENDING or REJECTED. Example: APPROVED
    template_typestring
    Only return templates of this type, for example TEXT, IMAGE, VIDEO, DOCUMENT, LOCATION, CAROUSEL or PRODUCT. Example: TEXT
  • gupshup_business_profile_about_updateSet the About text of a Gupshup app's WhatsApp business profile.Write

    Update Business Profile About

    Set the About text of a Gupshup app's WhatsApp business profile. Returns status success when the text is saved. Use this for the About line only. Use gupshup_business_profile_update for address, description, email and websites.

    • Idempotent

    Inputs

    aboutstringrequired
    New About text (up to 139 characters). Example: Shop the latest collections
    app_idstringrequired
    Gupshup app ID of the WhatsApp app, shown on the app's dashboard in the Gupshup console (Dashboard > WhatsApp > your app) and in the app settings. Example: cebxx8x1-xxf6-406c-901x-3f78xxxx5ea