Send Text Using Template with WhatsApp Business API on Custom Events (Instant) from Zoom API

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

Trigger workflow on

Custom Events (Instant) from the Zoom API

Next, do this

Send Text Using Template with the WhatsApp Business API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zoom trigger and WhatsApp Business action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Events (Instant) trigger
1. Connect your Zoom account
2. Select one or more Zoom Events
3. Configure apphook
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Custom Events (Instant) on Zoom

Description:Emit new events tied to your Zoom user or resources you own

Version:0.1.3

Key:zoom-custom-event

View on GitHub

Zoom Overview#

The Zoom API lets you tap into a rich set of functionalities to enhance the video conferencing experience within your own app or workflow. With the Zoom API on Pipedream, you can automatically create meetings, manage users, send meeting notifications, and more, orchestrating these actions within a broader automation. This allows for seamless integration with other services, enabling both data collection and action triggers based on Zoom events.

Pipedream workflows allow you to run any Node.js code that connects to the Zoom API. Just create a new workflow, then add prebuilt Zoom actions (create a meeting, send a chat message, etc.) or write your own code. These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc).

Trigger Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "zoom-custom-event",
  name: "Custom Events (Instant)",
  description: "Emit new events tied to your Zoom user or resources you own",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventNameOptions: {
      type: "string[]",
      label: "Zoom Events",
      description: "Select the events you want to listen for",
      options: Object.values(constants.CUSTOM_EVENT_TYPES),
    },
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    apphook: {
      type: "$.interface.apphook",
      appProp: "app",
      eventNames() {
        return this.eventNameOptions;
      },
    },
  },
  async run(event) {
    this.$emit(event, {
      id: event.payload?.object?.id,
      summary: event.event,
      ts: Date.now(),
    });
  },
};

Trigger 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.

Label	Prop	Type	Description
Zoom	`app`	`app`	This component uses the Zoom app.
Zoom Events	`eventNameOptions`	`string[]`	Select a value from the drop down menu:`meeting.alertmeeting.created.by_memeeting.created.for_memeeting.updatedmeeting.deleted.by_memeeting.deleted.for_memeeting.startedmeeting.endedmeeting.registration_createdmeeting.registration_approvedmeeting.registration_cancelledmeeting.registration_deniedmeeting.sharing_started.hostmeeting.sharing_started.participantmeeting.sharing_ended.hostmeeting.sharing_ended.participantmeeting.participant_jbh_joinedmeeting.participant_jbh_waitingmeeting.participant_joinedmeeting.participant_leftmeeting.participant_joined_waiting_roommeeting.participant_admittedmeeting.participant_put_in_waiting_roommeeting.participant_left_waiting_roomrecording.startedrecording.pausedrecording.resumedrecording.stoppedrecording.completedrecording.trashed.by_merecording.trashed.for_merecording.deleted.by_merecording.deleted.for_merecording.recovered.by_merecording.recovered.for_merecording.transcript_completedrecording.registration_createdrecording.registration_approvedrecording.registration_denieduser.updateduser.settings_updateduser.signed_inuser.signed_outwebinar.created.by_mewebinar.created.for_mewebinar.updatedwebinar.startedwebinar.endedwebinar.alertwebinar.sharing_started.hostwebinar.sharing_started.participantwebinar.sharing_endedwebinar.registration_createdwebinar.registration_approvedwebinar.registration_deniedwebinar.registration_cancelledwebinar.participant_joinedwebinar.participant_leftwebinar.deleted.by_mewebinar.deleted.for_me`
	`apphook`	`$.interface.apphook`

Trigger Authentication#

Zoom uses OAuth authentication. When you connect your Zoom account, Pipedream will open a popup window where you can sign into Zoom and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoom API.

Pipedream requests the following authorization scopes when you connect your account:

About Zoom#

Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.

Action#

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

View on GitHub

WhatsApp Business Overview#

The WhatsApp Business API on Pipedream is a powerful avenue for automating interactions with customers on WhatsApp. You can send messages, set up automated responses, and manage conversations on a large scale. With Pipedream's serverless platform, you can create workflows that trigger from various events and connect WhatsApp Business with numerous other apps to automate tasks, notify teams, sync data, and more, all without managing infrastructure.

Action 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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
WhatsApp Business	`whatsapp`	`app`	This component uses the WhatsApp Business app.
Phone Number ID	`phoneNumberId`	`string`	Select a value from the drop down menu.
Recipient Phone Number	`recipientPhoneNumber`	`string`	Enter the recipient's phone number. For example, `15101234567`.
Message Template	`messageTemplate`	`string`	Select a value from the drop down menu.

Action 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.

Send Text Using Template with WhatsApp Business API on Custom Events (Instant) from Zoom API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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