CONNECT APP
Build with Gupshup
Communication
- API key
MCP
Give your agent Gupshup tools
Every Gupshup action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Gupshup account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "gupshup",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run List Template ID Options:
const result = await mcp.callTool({
name: "gupshup-list-template-id-options",
arguments: {
page: 10,
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "gupshup",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run List Template ID Options:
result = await session.call_tool("gupshup-list-template-id-options", {
"page": 10,
})API PROXY
Call the Gupshup API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Gupshup API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed Gupshup endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Gupshup actions from your backend
Connect a user's Gupshup account once, then run List Template ID Options on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "gupshup-list-template-id-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
gupshup: { authProvisionId: "apn_xxxxxxx" },
page: 10,
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="gupshup-list-template-id-options",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"gupshup": {"authProvisionId": "apn_xxxxxxx"},
"page": 10,
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "gupshup-list-template-id-options",
"configured_props": {
"gupshup": { "authProvisionId": "apn_xxxxxxx" },
"page": 10
}
}'TOOLS
Gupshup actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
List Template ID Options
actionRetrieves available options for the Template ID field.Read-onlyv0.0.1 -
Send Template Message
actionSend a template message. Requires a paid Gupshup account. See the documentationWritev0.0.1 -
Update Subscription
actionUpdate a subscription. Requires a paid Gupshup account. See the documentationWritev0.0.1
EVENTS
Gupshup triggers
Event sources your backend can deploy for users and receive through a webhook.
No Gupshup triggers are available yet.
MULTI-APP
Use Gupshup with other popular apps
Most products don't stop at one integration. Pair Gupshup with the other apps your users rely on, and ship use cases that span both.
- App slug
- gupshup
- Authentication
- API key
- Categories
- Communication
- Actions
- 3
- Triggers
- 0
- API proxy
- Available