Add Contact with WATI API on New Message Received from Freshchat API

Pipedream makes it easy to connect APIs for WATI, Freshchat and 2,900+ other apps remarkably fast.

Trigger workflow on

New Message Received from the Freshchat API

Next, do this

Add Contact with the WATI 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 Freshchat trigger and WATI 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 Freshchat account
2. Configure timer
3. Select a User ID
4. Select a Conversation ID
Configure the Add Contact action
1. Connect your WATI account
2. Configure WhatsApp Number
3. Optional- Configure Name
4. Optional- Configure Custom Params
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 Freshchat

Description:Emit new event when a new message is received in a conversation. [See the documentation](https://developers.freshchat.com/api/#list_messages)

Version:0.0.1

Key:freshchat-new-message-received

View on GitHub

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "freshchat-new-message-received",
  name: "New Message Received",
  description: "Emit new event when a new message is received in a conversation. [See the documentation](https://developers.freshchat.com/api/#list_messages)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    userId: {
      propDefinition: [
        common.props.freshchat,
        "userId",
      ],
    },
    conversationId: {
      propDefinition: [
        common.props.freshchat,
        "conversationId",
        (c) => ({
          userId: c.userId,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastCreatedTime() {
      return this.db.get("lastCreatedTime");
    },
    _setLastCreatedTime(time) {
      this.db.set("lastCreatedTime", time);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New message received: ${message.id}`,
        ts: Date.parse(message.created_time),
      };
    },
    async processEvents(max) {
      const lastCreatedTime = this._getLastCreatedTime();
      let maxCreatedTime = lastCreatedTime;

      const results = this.freshchat.paginate({
        fn: this.freshchat.listMessages,
        args: {
          conversationId: this.conversationId,
        },
        resourceKey: "messages",
      });

      let messages = [];
      for await (const message of results) {
        if (!lastCreatedTime || Date.parse(message.created_time) > Date.parse(lastCreatedTime)) {
          if (!maxCreatedTime || Date.parse(message.created_time) > Date.parse(maxCreatedTime)) {
            maxCreatedTime = message.created_time;
          }
          messages.push(message);
        }
      }
      this._setLastCreatedTime(maxCreatedTime);

      if (max) {
        messages = messages.slice(0, max);
      }

      for (const message of messages) {
        this.$emit(message, this.generateMeta(message));
      }
    },
  },
  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
Freshchat	`freshchat`	`app`	This component uses the Freshchat app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
User ID	`userId`	`string`	Select a value from the drop down menu.
Conversation ID	`conversationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Freshchat#

Customer Messaging, Live Chat & Chatbots

Action#

Add Contact on WATI

Description:Adds a new contact on the WATI platform. [See the documentation](https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber)

Version:0.0.2

Key:wati-add-contact

View on GitHub

WATI Overview#

The WATI API allows you to power up your customer engagement by leveraging WhatsApp messaging. With Pipedream's capabilities, you can create serverless workflows that integrate WATI to automate personalized notifications, process inbound messages, and manage contacts. This can help scale your customer service, marketing campaigns, and streamline communications with WhatsApp's wide user base.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import wati from "../../wati.app.mjs";

export default {
  key: "wati-add-contact",
  name: "Add Contact",
  description: "Adds a new contact on the WATI platform. [See the documentation](https://docs.wati.io/reference/post_api-v1-addcontact-whatsappnumber)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    wati,
    whatsappNumber: {
      propDefinition: [
        wati,
        "whatsappNumber",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the contact",
      optional: true,
    },
    customParams: {
      propDefinition: [
        wati,
        "customParams",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.wati.addContact({
      $,
      whatsappNumber: this.whatsappNumber,
      data: {
        name: this.name,
        customParams: this.customParams && Object.entries(this.customParams).map(([
          key,
          value,
        ]) => ({
          name: key,
          value,
        })),
      },
    });
    if (!response.result) {
      throw new ConfigurationError(response.info);
    }
    $.export("$summary", `Successfully added contact with phone number: ${this.whatsappNumber}`);
    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
WATI	`wati`	`app`	This component uses the WATI app.
WhatsApp Number	`whatsappNumber`	`string`	Your WhatsApp number with country code.
Name	`name`	`string`	The name of the contact
Custom Params	`customParams`	`object`	An object with contact's custom fields.

Action Authentication#

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

To retrieve your Access Token and API Endpoint,