View as Markdown
WhatsApp Business icon

WhatsApp Business ACTION

Send Text Using Template

Send a text message using a pre-defined template. Variables can be sent only as text. See the docs.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's WhatsApp Business account once, then configure and run Send Text Using Template from your backend or agent.

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-send-text-using-template",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    whatsapp_business: { authProvisionId: "apn_xxxxxxx" },
    phoneNumberId: "Phone Number ID",
    recipientPhoneNumber: "Recipient Phone Number",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Send Text Using Template inputs
Property Type Description
phoneNumberId Phone Number ID string
Phone number ID that will be used to send the message.
Required Dynamic
recipientPhoneNumber Recipient Phone Number string
Enter the recipient's phone number. For example, 15101234567.
Required
messageTemplate Message Template string
Select the template you'd like to use.
Required Dynamic
headerVars Header Variables string[]
Array of header variables for programmatic/AI-agent use. Takes precedence over individual header props if provided.
Optional
bodyVars Body Variables string[]
Array of body variables for programmatic/AI-agent use. Takes precedence over individual body props if provided.
Optional
buttonVars Button Variables string[]
Array of button variables for programmatic/AI-agent use. Takes precedence over individual button props if provided.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
whatsapp_business-send-text-using-template
Version
0.0.7
App
WhatsApp Business
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes