Send Message in Chat with Freshchat API on New Event from ChatBot API

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

Trigger workflow on

New Event from the ChatBot API

Next, do this

Send Message in Chat with the Freshchat 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 ChatBot trigger and Freshchat action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event trigger
1. Connect your ChatBot account
2. Optional- Configure Webhook Name
Configure the Send Message in Chat action
1. Connect your Freshchat account
2. Select a User ID
3. Select a Conversation ID
4. Select a Actor Type
5. Optional- Select a Agent ID
6. Configure Message
7. Optional- Select a Message Type
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 Event on ChatBot

Description:Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)

Version:0.0.1

Key:chatbot-new-event

View on GitHub

ChatBot Overview#

Leverage the ChatBot API on Pipedream to automate conversations, streamline customer service, and connect chat functionality with various apps for rich, responsive interaction. With this API, you can programmatically send messages, manage chat histories, and implement chatbots that react to user input in real-time. By integrating with Pipedream, these capabilities can be augmented with thousands of apps, enabling seamless data flow and complex automations.

Trigger Code#

import chatbot from "../../chatbot.app.mjs";
import { v4 as uuid } from "uuid";

export default {
  key: "chatbot-new-event",
  name: "New Event",
  description: "Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)",
  version: "0.0.1",
  type: "source",
  props: {
    chatbot,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    name: {
      label: "Webhook Name",
      description: "The name of the webhook, this will be used to select in the ChatBot UI flow",
      type: "string",
      optional: true,
    },
  },
  methods: {
    async _respondWebHook(http, event) {
      http.respond({
        status: 200,
        body: event.query.challenge,
      });
    },
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const validationToken = uuid();

      const response = await this.chatbot.createWebhook({
        auth: {},
        headers: [],
        name: this.name ?? `Webhook ${validationToken}`,
        token: validationToken,
        url: this.http.endpoint,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.chatbot.deleteWebhook(webhookId);
    },
  },
  async run(event) {
    await this._respondWebHook(this.http, event);

    const {
      body,
      headers,
    } = event;

    this.$emit(body, {
      id: headers["x-request-id"],
      summary: `New event ${headers["x-request-id"]} received`,
      ts: new Date(),
    });
  },
};

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
ChatBot	`chatbot`	`app`	This component uses the ChatBot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.
Webhook Name	`name`	`string`	The name of the webhook, this will be used to select in the ChatBot UI flow

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your ChatBot account and sign in
Go to “Settings” > “Developers” > “API keys”

Note: The client access token should be used to invoke /query endpoint. For other API endpoints use the Developer access token

About ChatBot#

ChatBot is an all-in-one platform to create, deploy, and track chatbots across channels.

Action#

Send Message in Chat on Freshchat

Description:Sends a message in a specific conversation. [See the documentation](https://developers.freshchat.com/api/#send_message_to_conversation)

Version:0.0.3

Key:freshchat-send-message-in-chat

View on GitHub

Action Code#

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

export default {
  key: "freshchat-send-message-in-chat",
  name: "Send Message in Chat",
  description: "Sends a message in a specific conversation. [See the documentation](https://developers.freshchat.com/api/#send_message_to_conversation)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    freshchat,
    userId: {
      propDefinition: [
        freshchat,
        "userId",
      ],
    },
    conversationId: {
      propDefinition: [
        freshchat,
        "conversationId",
        (c) => ({
          userId: c.userId,
        }),
      ],
    },
    actorType: {
      type: "string",
      label: "Actor Type",
      description: "Type of the entity who sent the message to the conversation",
      options: [
        "user",
        "agent",
      ],
    },
    agentId: {
      propDefinition: [
        freshchat,
        "agentId",
      ],
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The content of the message to send",
    },
    messageType: {
      type: "string",
      label: "Message Type",
      description: "Type of message to be sent to the conversation",
      options: [
        "normal",
        "private",
      ],
      default: "normal",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.actorType === "agent" && !this.agentId) {
      throw new ConfigurationError("Agent ID is required when actor type is agent");
    }

    const data = {
      message_parts: [
        {
          text: {
            content: this.message,
          },
        },
      ],
      actor_type: this.actorType,
      actor_id: this.actorType === "user"
        ? this.userId
        : this.agentId,
      user_id: this.actorType === "user"
        ? this.userId
        : undefined,
      message_type: this.messageType,
    };
    try {
      await this.freshchat.sendMessageInChat({
        $,
        conversationId: this.conversationId,
        data,
      });
    } catch {
      // Sends message, but always returns the error
    /*   {
        "code": 400,
        "status": "INVALID_VALUE",
        "message": "com.demach.konotor.model.fragment.TextFragment cannot be cast to
          com.demach.konotor.model.fragment.EmailFragment"
      }
      */
    }
    $.export("$summary", `Sent message in conversation ${this.conversationId}`);
    return data;
  },
};

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
Freshchat	`freshchat`	`app`	This component uses the Freshchat app.
User ID	`userId`	`string`	Select a value from the drop down menu.
Conversation ID	`conversationId`	`string`	Select a value from the drop down menu.
Actor Type	`actorType`	`string`	Select a value from the drop down menu:`useragent`
Agent ID	`agentId`	`string`	Select a value from the drop down menu.
Message	`message`	`string`	The content of the message to send
Message Type	`messageType`	`string`	Select a value from the drop down menu:`normalprivate`