View as Markdown
Heyy icon

Heyy ACTION

Send WhatsApp Message

Sends a WhatsApp message to a contact. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Heyy account once, then configure and run Send WhatsApp Message 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: "heyy-send-whatsapp-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heyy: { authProvisionId: "apn_xxxxxxx" },
    channelId: "Channel ID",
    phoneNumber: "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 WhatsApp Message inputs
Property Type Description
channelId Channel ID string
The unique identifier of the channel.
Required Dynamic
phoneNumber Phone Number string
The phone number of the contact.
Required Dynamic
msgType Message Type string
The type of message to send.
Required

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
heyy-send-whatsapp-message
Version
0.0.3
App
Heyy
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes