CONNECT APP
Build with WhatsApp Business
Communication
- API key
MCP
Give your agent WhatsApp Business tools
Every WhatsApp Business 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 WhatsApp Business 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": "whatsapp_business",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run List Message Templates:
const result = await mcp.callTool({
name: "whatsapp_business-list-message-templates",
arguments: {},
})# 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": "whatsapp_business",
}
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 Message Templates:
result = await session.call_tool("whatsapp_business-list-message-templates", {})API PROXY
Call the WhatsApp Business API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the WhatsApp Business 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 WhatsApp Business 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 WhatsApp Business actions from your backend
Connect a user's WhatsApp Business account once, then run List Message Templates 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: "whatsapp_business-list-message-templates",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
whatsapp_business: { authProvisionId: "apn_xxxxxxx" },
},
})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="whatsapp_business-list-message-templates",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"whatsapp_business": {"authProvisionId": "apn_xxxxxxx"},
},
)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": "whatsapp_business-list-message-templates",
"configured_props": {
"whatsapp_business": { "authProvisionId": "apn_xxxxxxx" }
}
}'TOOLS
WhatsApp Business actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
List Message Templates
actionLists message templates. See the docs.Writev0.0.4 -
Send Text Message
actionSends a text message. See the docs.Writev0.0.4 -
Send Text Using Template
actionSend a text message using a pre-defined template. Variables can be sent only as text. See the docs.Writev0.0.7 -
Send Voice Message
actionSends a voice message. See the documentationWritev0.0.4
EVENTS
WhatsApp Business triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use WhatsApp Business with other popular apps
Most products don't stop at one integration. Pair WhatsApp Business with the other apps your users rely on, and ship use cases that span both.
REFERENCE
App details
Reference metadata for the WhatsApp Business connector in the Pipedream registry.
- App slug
- whatsapp_business
- Authentication
- API key
- Categories
- Communication
- Actions
- 4
- Triggers
- 1
- API proxy
- Available