← WhatsApp Business

Send Text Using Template with WhatsApp Business API

Pipedream makes it easy to connect APIs for WhatsApp Business and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Send Text Using Template with the WhatsApp Business API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Send Text Using Template with the WhatsApp Business API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Send Text Using Template action
    1. Connect your WhatsApp Business account
    2. Select a Phone Number ID
    3. Configure Recipient Phone Number
    4. Select a Message Template
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Send Text Using Template with WhatsApp Business API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + WhatsApp Business
 
Try it
Send Text Using Template with WhatsApp Business API on New Submission from Typeform API
Typeform + WhatsApp Business
 
Try it
Send Text Using Template with WhatsApp Business API on Custom Events from Zoom API
Zoom + WhatsApp Business
 
Try it
Send Text Using Template with WhatsApp Business API on New Submission (Instant) from Jotform API
Jotform + WhatsApp Business
 
Try it
Send Text Using Template with WhatsApp Business API on New Custom Webhook Events from Stripe API
Stripe + WhatsApp Business
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Send Text Using Template on WhatsApp Business
Description:Send a text message using a pre-defined template. Variables can be sent only as text. [See the docs.](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#message-templates)
Version:0.0.5
Key:whatsapp_business-send-text-using-template

Code

import whatsapp from "../../whatsapp_business.app.mjs";

const docLink = "https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages#message-templates";
const regex = /{{\d+}}/g;

export default {
  key: "whatsapp_business-send-text-using-template",
  name: "Send Text Using Template",
  description: `Send a text message using a pre-defined template. Variables can be sent only as text. [See the docs.](${docLink})`,
  version: "0.0.5",
  type: "action",
  props: {
    whatsapp,
    phoneNumberId: {
      propDefinition: [
        whatsapp,
        "phoneNumberId",
      ],
    },
    recipientPhoneNumber: {
      propDefinition: [
        whatsapp,
        "recipientPhoneNumber",
      ],
    },
    messageTemplate: {
      propDefinition: [
        whatsapp,
        "messageTemplate",
      ],
      withLabel: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    const template = await this.whatsapp.getMessageTemplate({
      templateId: this.messageTemplate.value,
    });

    for (const component of template.components) {
      if (component.type === "HEADER" && component.format === "TEXT" && component.text.match(regex)) {
        // only 1 header variable is possible
        props["header_{{1}}"] = {
          type: "string",
          label: "Header {{1}}",
          description: `Template header text: **${component.text}**`,
        };
        continue;
      }

      if (component.type === "BUTTONS") {
        for (const button of component.buttons) {
          if (button.type === "URL" && button.url.match(regex)) {
            // only 1 dynamic url button possible
            props["button_{{1}}"] = {
              type: "string",
              label: button.text,
              description: `Dynamic URL: **${button.url}** Enter the dynamic text only.`,
            };
            continue;
          }
        }
      }

      const matches = component.text?.match(regex);
      for (const match of matches ?? []) {
        props[match] = {
          type: "string",
          label: match,
          description: `Template text: **${component.text}**`,
        };
      }
    }

    return props;
  },
  async run({ $ }) {
    const components = [];
    const [
      templateName,
      language,
    ] = this.messageTemplate.label.split(" - ");

    const headerParameters = Object.keys(this)
      .filter((key) => key === "header_{{1}}")
      .map((key) => ({
        type: "text",
        text: this[key],
      }));

    if (headerParameters.length) {
      components.push({
        type: "header",
        parameters: headerParameters,
      });
    }

    const buttonParameters = Object.keys(this)
      .filter((key) => key.includes("button_"))
      .map((key) => ({
        type: "text",
        text: this[key],
      }));

    if (buttonParameters.length) {
      components.push({
        type: "button",
        sub_type: "url",
        index: 0,
        parameters: buttonParameters,
      });
    }

    const bodyParameters = Object.keys(this)
      .filter((key) => key.match(regex) && key !== "header_{{1}}" && key !== "button_{{1}}")
      .map((key) => ({
        type: "text",
        text: this[key],
      }));

    components.push({
      type: "body",
      parameters: bodyParameters,
    });

    const response = await this.whatsapp.sendMessageUsingTemplate({
      $,
      phoneNumberId: this.phoneNumberId,
      to: this.recipientPhoneNumber,
      name: templateName,
      language,
      components,
    });
    $.export("$summary", `Message sent using ${templateName} template`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
WhatsApp BusinesswhatsappappThis component uses the WhatsApp Business app.
Phone Number IDphoneNumberIdstringSelect a value from the drop down menu.
Recipient Phone NumberrecipientPhoneNumberstring

Enter the recipient's phone number. For example, 15101234567.

Message TemplatemessageTemplatestringSelect a value from the drop down menu.

Authentication

WhatsApp Business uses API keys for authentication. When you connect your WhatsApp Business account, Pipedream securely stores the keys so you can easily authenticate to WhatsApp Business APIs in both code and no-code steps.

To connect your WhatsApp Business Cloud account to Pipedream, follow the steps below to find your Business Account ID and your Permanent Access Token.

For additional info on setting up a WhatsApp Business account, refer to their getting started docs.

About WhatsApp Business

WhatsApp Business products support businesses from large to small. Engage audiences, accelerate sales and drive better customer support outcomes on the platform with more than 2 billion users around the world.

More Ways to Use WhatsApp Business

Triggers

New Message Sent from the WhatsApp Business API

Emit new event when a new message is sent or received. A Webhook subscribed to field "messages" must be set up from the App Dashboard of your Facebook Developer Account. See documentation for more information about Webhook setup.

 
Try it

Actions

List Message Templates with the WhatsApp Business API

Lists message templates. See the docs.

 
Try it
Send Text Message with the WhatsApp Business API

Sends a text message. See the docs.

 
Try it
Send Voice Message with the WhatsApp Business API

Sends a voice message. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.