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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Gupshup connection
In AgentKit > Connections, create a Gupshup connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'gupshup'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst 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.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "gupshup"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Gupshup:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={"app_id":"YOUR_APP_ID"},tool_name="gupshup_blocked_users_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolgupshup_blocked_users_listList the WhatsApp users your Gupshup app's business number has blocked, one page at a time.Read-onlyList 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-onlyGet 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-onlyGet 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-onlyGet 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-onlyGet 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-onlyGet 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-onlyList 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.WriteUpdate 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
gupshup_business_profile_updateCreate or update the public WhatsApp business profile of a Gupshup app: address, description, email, vertical and websites.WriteUpdate Business Profile
Create or update the public WhatsApp business profile of a Gupshup app: address, description, email, vertical and websites. Returns status success when the profile is saved. Use this to change profile fields. Use gupshup_business_profile_about_update for the About text.
- Idempotent
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
address_line_1string- First line of the business address. Example: 101, Silver Metropolis
address_line_2string- Second line of the business address. Example: Goregaon East
citystring- City of the business address. Example: Mumbai
countrystring- Country of the business address. Example: India
descriptionstring- Business description shown on the profile. Example: Fashion and lifestyle store
pin_codestring- Postal code of the business address. Example: 400063
profile_emailstring- Contact email shown on the profile. Example: support@example.com
statestring- State of the business address. Example: Maharashtra
verticalstring- Business category shown on the profile, for example Retail, Education, Professional Services or Other. Example: Retail
website_1string- First website URL shown on the profile. Example: https://www.example.com
website_2string- Second website URL shown on the profile. Example: https://shop.example.com
gupshup_marketing_message_sendSend an approved marketing template through Meta's Marketing Messages Lite API via Gupshup, using the Cloud API template payload.WriteSend Marketing Message (MM Lite)
Send an approved marketing template through Meta's Marketing Messages Lite API via Gupshup, using the Cloud API template payload. Returns the Cloud API response with the recipient's wa_id and the message id. Use this only for MARKETING templates on apps onboarded to MM Lite. Use gupshup_template_message_send for utility and authentication templates.
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
templateobjectrequired- Meta template payload: the template name, a language object with the code (and policy deterministic), and a components list with the body, header and button parameters. Example: {"name": "diwali_offer", "language": {"policy": "deterministic", "code": "en"}, "components": [{"type": "body", "parameters": [{"type": "text", "text": "John"}]}]}
tostringrequired- Recipient's WhatsApp number in international format with country code. Example: 919876543210
gupshup_product_template_message_sendSend an approved catalog or multi-product (MPM) WhatsApp template message from your Gupshup app.WriteSend Catalog Template Message
Send an approved catalog or multi-product (MPM) WhatsApp template message from your Gupshup app. Returns status submitted and the Gupshup messageId. Use this only for catalog and multi-product templates, which Gupshup sends through its raw message endpoint. Use gupshup_template_message_send for every other template type. Needs the template id from gupshup_templates_list.
Inputs
app_namestringrequired- Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
destinationstringrequired- Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
sourcestringrequired- Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
templatestringrequired- JSON-encoded template object with the Gupshup template id and its params. For multi-product templates the last param must be the retailer ID of the product used as the thumbnail. Example: {"id":"a1b2c3d4-0000-4000-8000-1234567890ab","params":["Diwali sale","SKU-1001"]}
gupshup_session_message_sendSend a free-form WhatsApp session message (text, media, location, reaction, list, quick reply, product or CTA URL) from your Gupshup app.WriteSend Session Message
Send a free-form WhatsApp session message (text, media, location, reaction, list, quick reply, product or CTA URL) from your Gupshup app. Returns status submitted and the Gupshup messageId; delivery and read updates arrive on your app's callback URL. Use this inside the 24-hour customer service window. Use gupshup_template_message_send to start a conversation with an approved template.
Inputs
app_namestringrequired- Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
destinationstringrequired- Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
messagestringrequired- The WhatsApp message as a JSON-encoded string (Gupshup reads this form field as JSON). Set type to one of: text (text, optional previewUrl), image (originalUrl, previewUrl, optional caption), video, audio, file (url, filename), sticker (url), location (longitude, latitude, name, address), reaction (msgId of the message to react to, emoji), list or quick_reply (interactive menus with options), catalog, product, product_details or cta_url. Add a context object with msgId to reply to a specific message. Session messages only reach users who messaged you in the last 24 hours. Example: {"type":"text","text":"Hi John, your order has shipped.","previewUrl":false}
sourcestringrequired- Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
disable_previewboolean- Set true to stop WhatsApp from showing a link preview for a URL in a text message. Example: true
gupshup_template_message_sendSend an approved WhatsApp template message (text, media header, location, coupon code, carousel, limited-time offer or authentication) from your Gupshup app.WriteSend Template Message
Send an approved WhatsApp template message (text, media header, location, coupon code, carousel, limited-time offer or authentication) from your Gupshup app. Returns status submitted and the Gupshup messageId; delivery status arrives on your app's callback URL. Use this to start or resume a conversation outside the 24-hour window. Use gupshup_session_message_send for free-form replies and gupshup_product_template_message_send for catalog and multi-product templates. Needs the template id from gupshup_templates_list.
Inputs
destinationstringrequired- Recipient's WhatsApp number in international format with country code and no plus sign. Example: 919876543210
sourcestringrequired- Your business WhatsApp number that sends the message, registered to the app, in international format with country code and no plus sign. Example: 917834811114
templatestringrequired- JSON-encoded template object: id is the Gupshup template ID and params is the list of values for the template's {{1}}, {{2}}... placeholders in order (an empty list for templates without variables). Carousel and limited-time-offer templates add their card or expiry objects as shown in Gupshup's template message docs. Example: {"id":"312371e9-2771-463b-8cfd-cd8994b810cc","params":["John","ORD-1042"]}
app_namestring- Name of the Gupshup app that the source number belongs to, exactly as shown in the Gupshup console. Example: DemoApp
messagestring- JSON-encoded media header for templates with an image, video, document or location header, for example an image object with a link or a media id. Leave empty for text-only templates. Example: {"type":"image","image":{"link":"https://example.com/banner.jpg"}}
postback_textsstring- JSON-encoded list of postback texts for the template's quick-reply buttons: each item gives the button index and the text Gupshup returns in the inbound event when the user taps it. Example: [{"index":0,"text":"confirm_order_1042"}]
gupshup_users_blockBlock one or more WhatsApp users from messaging your Gupshup app's business number.WriteBlock Users
Block one or more WhatsApp users from messaging your Gupshup app's business number. Returns the blocked users with their input number and wa_id, and any that failed. Use this to stop abusive users. You can only block users who messaged you in the last 24 hours, up to 64,000 per WhatsApp Business Account. Use gupshup_users_unblock to undo.
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
usersarrayrequired- Phone numbers of the users to block, in international format with country code. Example: ["919876543210"]
gupshup_users_unblockUnblock one or more WhatsApp users so they can message your Gupshup app's business number again.WriteUnblock Users
Unblock one or more WhatsApp users so they can message your Gupshup app's business number again. Returns the unblocked users with their input number and wa_id. Use this to reverse gupshup_users_block. Use gupshup_blocked_users_list to see who is blocked.
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
usersarrayrequired- Phone numbers of the users to unblock, in international format with country code. Example: ["919876543210"]
No tools match.