Send Text Using Template with WhatsApp Business API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid 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 Twilio SendGrid 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 New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
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#

New Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.7

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

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.

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.