Send Message with WhatsAble API on New Message Received from Esendex API

Pipedream makes it easy to connect APIs for WhatsAble, Esendex and 2,700+ other apps remarkably fast.

Trigger workflow on

New Message Received from the Esendex API

Next, do this

Send Message with the WhatsAble 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 Esendex trigger and WhatsAble 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 Received trigger
1. Connect your Esendex account
2. Configure timer
3. Optional- Select a Type
4. Optional- Select a Status
Configure the Send Message action
1. Connect your WhatsAble account
2. Configure Phone Number
3. Configure Message
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 Received on Esendex

Description:Emit new event when a new message is received. [See the documentation](https://developers.esendex.com/api-reference/#messageheader)

Version:0.0.1

Key:esendex-new-message-received

View on GitHub

Esendex Overview#

The Esendex API enables seamless SMS, Business WhatsApp and voice messaging integration into your applications. On Pipedream, you can harness this API to create serverless workflows that react to various triggers, from inbound messages to scheduled times, and interact with other services to provide a cohesive automation experience.

Trigger Code#

import esendex from "../../esendex.app.mjs";
import constants from "../../common/constants.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import xml2json from "simple-xml2json";
import sampleEmit from "./test-event.mjs";

export default {
  key: "esendex-new-message-received",
  name: "New Message Received",
  description: "Emit new event when a new message is received. [See the documentation](https://developers.esendex.com/api-reference/#messageheader)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    esendex,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the messages to watch for: either SMS or Voice. If no type is specified, all types are returned.",
      options: constants.MESSAGE_TYPES,
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Filter messages by status. If no status is specified, all statuses are returned.",
      options: constants.MESSAGE_STATUSES,
      optional: true,
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(ts) {
      this.db.set("lastTs", ts);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message Received: ${message.id}`,
        ts: Date.parse(message.laststatusat),
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      let maxTs = lastTs;

      const xmlResponse = await this.esendex.listMessages({
        params: {
          start: lastTs,
          finish: new Date().toISOString()
            .split(".")[0] + "Z", // current time
          status: this.status,
        },
      });

      const { messageheaders } = xml2json.parser(xmlResponse);
      let messages = messageheaders?.messageheader || [];
      if (!Array.isArray(messages)) {
        messages = [
          messages,
        ];
      }

      if (!messages.length) {
        return;
      }

      let count = 0;
      for (const message of messages) {
        if ((!lastTs || Date.parse(message.laststatusat) > Date.parse(lastTs))
          && (!this.type || message.type === this.type)) {
          const meta = this.generateMeta(message);
          this.$emit(message, meta);
          if (!maxTs || Date.parse(message.laststatusat) > Date.parse(maxTs)) {
            maxTs = message.laststatusat;
          }
          if (max && ++count >= max) {
            break;
          }
        }
      }

      this._setLastTs(maxTs);
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  async run() {
    await this.processEvent();
  },
  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
Esendex	`esendex`	`app`	This component uses the Esendex app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Type	`type`	`string`	Select a value from the drop down menu:`SMSVoice`
Status	`status`	`string`	Select a value from the drop down menu:`AcknowledgedAuthorisedConnectingDeliveredDispatchedExpiredFailedFailedAuthorisationPartiallyDeliveredProcessingQueuedRejectedScheduledSentSubmitted`

Trigger Authentication#

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

About Esendex#

We're a global business communication provider, delivering reliable SMS, voice, web and multichannel solutions.

Action#

Send Message on WhatsAble

Description:Sends a message to a verified WhatsApp number. [See the documentation](https://www.whatsable.app/api)

Version:0.0.1

Key:whatsable-send-message

View on GitHub

WhatsAble Overview#

The WhatsAble API enables automated interactions with WhatsApp, allowing you to send messages, create groups, and manage contacts programmatically. Integrating WhatsAble with Pipedream, you can craft serverless workflows that react to various triggers and perform actions on WhatsApp, like sending notifications or processing incoming messages. Pipedream's capability to connect with hundreds of apps opens up a multitude of automation possibilities, streamlining communication tasks and linking WhatsApp with your digital ecosystem.

Action Code#

import whatsable from "../../whatsable.app.mjs";

export default {
  key: "whatsable-send-message",
  name: "Send Message",
  description: "Sends a message to a verified WhatsApp number. [See the documentation](https://www.whatsable.app/api)",
  version: "0.0.1",
  type: "action",
  props: {
    whatsable,
    phoneNumber: {
      propDefinition: [
        whatsable,
        "phoneNumber",
      ],
    },
    message: {
      propDefinition: [
        whatsable,
        "message",
      ],
    },
  },
  methods: {
    _sanitizePhoneNumber(phoneNumber) {
      return `+${phoneNumber.replace(/[^\w\s]/gi, "")}`;
    },
  },
  async run({ $ }) {
    const sanitizedNumber = this._sanitizePhoneNumber(this.phoneNumber);

    const response = await this.whatsable.sendMessage({
      $,
      data: {
        to: sanitizedNumber,
        text: this.message,
      },
    });

    $.export("$summary", `Successfully sent message to ${this.phoneNumber}`);

    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
WhatsAble	`whatsable`	`app`	This component uses the WhatsAble app.
Phone Number	`phoneNumber`	`string`	The phone number to send the message to, in E164 format (e.g., +34677327718). Hyphens will be removed if included.
Message	`message`	`string`	The message to send to the phone number.