[Data] Parse JSON with Formatting API on New Message Sent from WhatsApp Business API

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

Trigger workflow on

New Message Sent from the WhatsApp Business API

Next, do this

[Data] Parse JSON with the Formatting 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 WhatsApp Business trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Message Sent trigger
1. Connect your WhatsApp Business account
Configure the [Data] Parse JSON action
1. Connect your Formatting account
2. Configure Input
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 Message Sent on WhatsApp Business

Description: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](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.

Version:0.0.4

Key:whatsapp_business-new-message-sent

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.

Trigger Code#

import whatsapp from "../../whatsapp_business.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "whatsapp_business-new-message-sent",
  name: "New Message Sent",
  description: "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](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    whatsapp,
    db: "$.service.db",
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
  },
  methods: {
    _getChallengeToken() {
      return this.db.get("challengeToken");
    },
    _setChallengeToken(challengeToken) {
      this.db.set("challengeToken", challengeToken);
    },
  },
  async run(event) {
    const {
      body, query,
    } = event;
    if (query["hub.challenge"]) {
      this._setChallengeToken(query["hub.challenge"]);
    }
    const challengeToken = this._getChallengeToken();

    this.httpInterface.respond({
      status: "200",
      body: challengeToken,
      headers: {
        "content-type": "application/json",
      },
    });

    if (!body) {
      return;
    }

    const entries = body?.entry || [];
    for (const entry of entries) {
      if (entry.changes && entry.changes?.length > 0) {
        const status = entry?.changes[0]?.value?.statuses
          ? entry?.changes[0]?.value?.statuses[0]?.status
          : null;
        if (status && status !== "sent") {
          continue;
        }
      }
      this.$emit(entry, {
        id: Date.now(),
        summary: "New Message Sent",
        ts: Date.now(),
      });
    }
  },
  sampleEmit,
};

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
WhatsApp Business	`whatsapp`	`app`	This component uses the WhatsApp Business app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

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

Action#

[Data] Parse JSON on Formatting

Description:Parse a JSON string

Version:0.0.5

Key:formatting-parse-json

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Parse JSON",
    description: "Parse a JSON string",
    key: "formatting-parse-json",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "A valid JSON format string to be parsed.",
            type: "string",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.parse(this.input);
            $.export("$summary", "Successfully parsed JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error parsing input as JSON: " + err.toString());
        }
    },
});

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
Formatting	`app`	`app`	This component uses the Formatting app.
Input	`input`	`string`	A valid JSON format string to be parsed.

Action Authentication#

The Formatting API does not require authentication.

About Formatting#

Pre-built actions to make formatting and manipulating data within your workflows easier.