WhatsApp

output.whatsapp Output v0.1.0

Sends WhatsApp messages via the Meta Cloud API: text, templates, media (image/document/audio/video/sticker from a link or binary input), location, contacts, interactive buttons and lists, reactions, mark-as-read, and media upload/download. Leave the text blank on sendText to send the input payload as text.

The WhatsApp step on the Studio canvas
The WhatsApp step as it appears on the Studio canvas — input pins on the left, output ports on the right.

Finding it in the library

Search the builder's node library for WhatsApp (it lives under Output). A single click opens the in-editor docs panel shown here — description, ports, and every property, without leaving the canvas. Double-click (or drag) to add it to the workflow.

WhatsApp in the node library, with the in-editor docs panel open
The library entry and the in-editor docs panel for WhatsApp — the same reference this page is generated from.

Wired up in the builder

WhatsApp in a real, runnable flow — captured live from the Studio editor, exactly as it looks on your canvas. This is the same workflow used for the example input & output below.

WhatsApp wired into a runnable workflow in the Studio builder
WhatsApp wired into a runnable flow — input on the left, output on the right.

How it’s configured

The node’s Configure panel as it opens in the builder when you select the step — every setting laid out with real values. Click any field to edit it.

The WhatsApp node's Configure panel in the Studio builder
The Configure panel for WhatsApp, showing the settings from the flow above.

Ports

Ports are the node’s contract with its neighbours. In the editor a port label renders bold when wired and italic when optional; ports accept attachment carriers rather than data wires.

DirectionPortLabelWhat flows through it
InputinputInput
OutputoutputResult

How data flows through it

WhatsApp consumes the content of the incoming envelope — when it is fed directly by a trigger, the trigger’s wrapper is unwrapped at the node boundary so the node sees the actual data, not the metadata shell. Its output becomes the payload for the next node, while the envelope (trace ids, correlation, binary refs) rides along untouched. In the Runs view you always see the whole envelope for both sides of this node.

Expressions in the config

String-typed properties accept {{ }} expressions evaluated against the incoming item at run time — e.g. {{ $json.customer.email }}. On this node that’s accessToken, phoneNumberId, to, text, templateName, templateLanguage, mediaLink, mediaType, caption, filename, latitude, longitude, locationName, locationAddress, bodyText, headerText, footerText, listButtonText, emoji, messageId, mediaId, baseUrl, apiVersion. JSON- and code-typed fields never interpolate — they are passed through literally.

Build it with AI

Every node in this reference is reachable through Flowdrome’s AI Copilot and the MCP tools — say what you want, and the graph surgery happens server-side. Node types resolve fuzzily, so the catalog label (WhatsApp) works as well as the exact type id (output.whatsapp).

In the Copilot panel (or any connected AI):

add a whatsapp node after the trigger

As a step in a create_chain_workflow call:

{"type":"WhatsApp","config":{}}
Raw MCP call — add this node to a workflow with add_node
curl -s -X POST http://localhost:48170/mcp -H "content-type: application/json" -d '{ "jsonrpc": "2.0", "id": "1", "method": "tools/call", "params": { "name": "add_node", "arguments": { "workflowId": "<id>", "type": "WhatsApp" } } }'

Example input & output

Captured from a real test run of the workflow above — this is what you see in the run data panel after pressing Test workflow.

Input — what the node received

The WhatsApp node's input envelope in the run data viewer
The input envelope in the Runs view — Flowdrome always shows the whole envelope, with the payload inside body.

Output — what the node produced

The WhatsApp node's output envelope in the run data viewer
The output envelope after the step ran.

Property reference

Every setting, with its type and default — the same fields shown configured in the panel above.

PropertyTypeDefaultDescription
Credential
credentialId
credential "" Use a stored credential for this connection — its fields are filled in at run start. Pick "None" to enter the connection details manually.
accepts credential templates: whatsapp
Access token
accessToken
string "" Meta Cloud API access token — use ${credential.whatsapp.accessToken}. Empty is allowed here; it must resolve by run time.
Phone number ID
phoneNumberId
string "" The WhatsApp Business phone-number ID that sends the message.
Shown when waOp(c) !== "getMedia"
Operation
operation
select "sendText" What to send: text, template, media (image/document/audio/video/sticker), location, contacts, interactive buttons/list, a reaction, mark-as-read, or media upload/download.
getMediamarkReadsendAudiosendButtonssendContactssendDocumentsendImagesendListsendLocationsendReactionsendStickersendTemplatesendTextsendVideouploadMedia
To
to
string "" Recipient phone number in international format, digits only (e.g. 15551234567).
Shown when !["uploadMedia", "getMedia", "markRead"].includes(waOp(c))
Text
text
string "" Message text. Leave blank to send the input payload as text.
Shown when waOp(c) === "sendText"
Preview links
previewUrl
boolean false Show a preview for the first URL in the text.
Shown when waOp(c) === "sendText"
Template name
templateName
string "" An approved WhatsApp message-template name.
Shown when waOp(c) === "sendTemplate"
Template language
templateLanguage
string "en_US" The template's language/locale code, e.g. en_US.
Shown when waOp(c) === "sendTemplate"
Template components
templateComponents
json [] JSON array of template components (header/body/button parameters), e.g. [{ "type": "body", "parameters": [{ "type": "text", "text": "Ada" }] }].
Shown when waOp(c) === "sendTemplate"
Media link
mediaLink
string "" Public HTTPS URL of the media to send. Leave blank when uploading from the binary field.
Shown when WA_MEDIA_OPS.includes(waOp(c))
Binary field
binaryField
field "" Dot-path to binary input to UPLOAD first (a blob, base64 envelope, or { name, contentType, data }). Takes precedence over the media link.
Shown when [...WA_MEDIA_OPS, "uploadMedia"].includes(waOp(c))
Media MIME type
mediaType
string "" MIME type for the uploaded file (e.g. image/png). Blank = the carrier's own content type.
Shown when waOp(c) === "uploadMedia"
Caption
caption
string "" Caption for the media (image/document/video only).
Shown when ["sendImage", "sendDocument", "sendVideo"].includes(waOp(c))
File name
filename
string "" Filename shown to the recipient (document) / for the upload.
Shown when ["sendDocument", "uploadMedia"].includes(waOp(c))
Latitude
latitude
string "" Latitude of the location.
Shown when waOp(c) === "sendLocation"
Longitude
longitude
string "" Longitude of the location.
Shown when waOp(c) === "sendLocation"
Location name
locationName
string "" Optional name of the place.
Shown when waOp(c) === "sendLocation"
Location address
locationAddress
string "" Optional street address of the place.
Shown when waOp(c) === "sendLocation"
Contacts
contacts
json [] JSON array of WhatsApp contact cards, e.g. [{ "name": { "formatted_name": "Ada", "first_name": "Ada" }, "phones": [{ "phone": "+15551234567" }] }].
Shown when waOp(c) === "sendContacts"
Body text
bodyText
string "" The interactive message's body text.
Shown when ["sendButtons", "sendList"].includes(waOp(c))
Header text
headerText
string "" Optional header line above the body.
Shown when ["sendButtons", "sendList"].includes(waOp(c))
Footer text
footerText
string "" Optional footer line below the body.
Shown when ["sendButtons", "sendList"].includes(waOp(c))
Reply buttons
buttons
json [] JSON array of up to 3 reply buttons, e.g. [{ "id": "yes", "title": "Yes" }, { "id": "no", "title": "No" }].
Shown when waOp(c) === "sendButtons"
List button
listButtonText
string "Choose" The label on the button that opens the list.
Shown when waOp(c) === "sendList"
List sections
listSections
json [] JSON array of list sections, e.g. [{ "title": "Plans", "rows": [{ "id": "pro", "title": "Pro", "description": "$9/mo" }] }].
Shown when waOp(c) === "sendList"
Emoji
emoji
string "👍" The reaction emoji (empty string removes a reaction).
Shown when waOp(c) === "sendReaction"
Message ID
messageId
string "" The inbound message id to react to / mark as read.
Shown when ["sendReaction", "markRead"].includes(waOp(c))
Media ID
mediaId
string "" The media id to download (binary-safe: text stays text, small binary inline, large binary as a blob).
Shown when waOp(c) === "getMedia"
Base URL
baseUrl
string "https://graph.facebook.com" Graph API base URL (override for testing).
API version
apiVersion
string "v20.0" Graph API version segment, e.g. v20.0.
Timeout (ms)
timeoutMs
int 15000 Abort the request after this many milliseconds.

Related nodes

The rest of the Output group — the same folder you’d scan in the editor’s library.

This page is generated from the node registry by gen-node-docs.mjs on every site build — ports, properties, defaults and visibility rules cannot drift from the code. The screenshots and example data are captured from a live Flowdrome by npm run shots:nodes and npm run gen:examples.