Portal Community
What this node does: The WhatsApp node connects to the Meta WhatsApp Business Cloud API. It provides 34 operations across 5 resources — message, media, template, profile, and group. All phone numbers must be in E.164 format (e.g. +14155552671). Authentication requires an AccessToken and PhoneNumberId from your Meta/WhatsApp Business API setup.

Authentication

CredentialDescription
AccessTokenMeta/WhatsApp Business API access token. Generated in Meta Business Manager under System Users. Long-lived tokens are recommended for production.
PhoneNumberIdThe numeric phone number ID assigned to your WhatsApp Business phone number in Meta's API. Found in the WhatsApp Business Manager under Phone Numbers.

Resources and Operations

message — 15 Operations

OperationDescription
message/sendTextSend a plain text message to a phone number. Supports PreviewUrl to unfurl links.
message/sendImageSend an image by URL or base64. Optional caption.
message/sendVideoSend a video by URL or base64. Optional caption.
message/sendAudioSend an audio file by URL or base64.
message/sendDocumentSend a document (PDF, DOCX, etc.) by URL or base64. Optional filename and caption.
message/sendStickerSend a WebP sticker by URL.
message/sendLocationSend a map pin with latitude, longitude, and optional name/address.
message/sendContactsSend a vCard-style contact or contact list as a JSON array.
message/sendInteractiveButtonsSend a message with up to 3 quick-reply buttons (each with id and title). Optional header and footer.
message/sendInteractiveListSend a scrollable list with sections and rows. Customer taps a button to open the list.
message/sendReactionReact to a specific message with a unicode emoji.
message/sendTemplateSend a pre-approved Meta template with language code and optional component parameters.
message/sendAndWaitSend a message and suspend the workflow until a reply is received (or timeout). Used for approval and response-collection flows.
message/markAsReadMark a received message as read by its MessageId.
message/sendTypingIndicatorShow a typing indicator to the recipient before sending a follow-up message.

media — 4 Operations

OperationDescription
media/uploadUpload a base64-encoded file to WhatsApp media hosting. Returns a MediaId for use in send operations.
media/downloadDownload media by MediaId. Returns base64 file data.
media/deleteDelete an uploaded media file by MediaId.
media/getInfoRetrieve metadata for a media file: mimeType, fileSize, url, sha256.

template — 3 Operations

OperationDescription
template/createCreate a new message template for Meta approval review. Requires BusinessAccountId.
template/listList all templates for a Business Account with optional pagination.
template/getRetrieve a specific template by TemplateId.

profile — 2 Operations

OperationDescription
profile/getContactGet the contact profile of the phone number: name, phone, profilePictureUrl.
profile/getBusinessProfileGet the business profile: description, address, email, websites, vertical.

group — 10 Operations

OperationDescription
group/createCreate a new group with a subject and initial participants (array of phone numbers).
group/getGet group metadata by GroupId.
group/deleteDelete a group by GroupId.
group/getMembersList all members of a group.
group/addMemberAdd a phone number to a group.
group/removeMemberRemove a phone number from a group.
group/promoteAdminPromote a group member to admin.
group/demoteAdminDemote a group admin to regular member.
group/getInviteLinkGet the shareable invite link for a group.
group/sendMessageSend a text message to a group by GroupId.

WhatsApp Business Cloud API — Setup

Before using this node, complete these steps in Meta's developer portal:

  1. Create a Meta App at developers.facebook.com and add the WhatsApp product.
  2. In WhatsApp > Getting Started, note your Phone Number ID and generate a temporary access token (or create a System User for a permanent long-lived token).
  3. Add a real phone number or use the sandbox test number for development.
  4. Submit your phone number for business verification if sending templates to non-test numbers.
  5. Store the AccessToken and PhoneNumberId in BizFirst Credentials Manager and reference them in the node.
Phone number format: All recipient fields (To, PhoneNumber) must be E.164 format — a plus sign followed by the country code and number with no spaces, dashes, or parentheses. Example: +14155552671. Messages sent to incorrectly formatted numbers will fail at the API level.

In This Guide

Configuration

Full properties table for all 34 operations organised by resource.

Input & Output

Output schemas per operation, sendAndWait suspend/resume behaviour, and webhook output fields.

Examples

Five examples: product catalog with interactive list, sendAndWait order flow, media upload and share, group announcement, and template appointment reminder.