Send Bot Message with Zoho Cliq API on New Row Created from Coda API

Pipedream makes it easy to connect APIs for Zoho Cliq, Coda and 2,400+ other apps remarkably fast.

Trigger workflow on

New Row Created from the Coda API

Next, do this

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

Select this integration
Configure the New Row Created trigger
1. Connect your Coda account
2. Configure timer
3. Select a Doc ID
4. Select a Table ID
5. Optional- Configure Include Updated Rows
Configure the Send Bot Message action
1. Connect your Zoho Cliq account
2. Configure Bot Name
3. Configure Text
4. Optional- Configure Broadcast
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 Row Created on Coda

Description:Emit new event for every created / updated row in a table. [See the documentation.](https://coda.io/developers/apis/v1#tag/Rows/operation/listRows)

Version:0.0.4

Key:coda-row-created

View on GitHub

Coda Overview#

The Coda API enables you to interact with your Coda docs for both data retrieval and manipulation. By leveraging this API on Pipedream, you can automate document updates, synchronize data across different platforms, orchestrate complex workflows, and react to changes in real-time. Coda’s tables can act as dynamic databases that interconnect with various services, allowing you to streamline operations that depend on the timely and accurate exchange of information.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import coda from "../../coda.app.mjs";

export default {
  key: "coda-row-created",
  name: "New Row Created",
  description: "Emit new event for every created / updated row in a table. [See the documentation.](https://coda.io/developers/apis/v1#tag/Rows/operation/listRows)",
  type: "source",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    coda,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    docId: {
      propDefinition: [
        coda,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        coda,
        "tableId",
        (c) => ({
          docId: c.docId,
        }),
      ],
    },
    includeUpdates: {
      type: "boolean",
      label: "Include Updated Rows",
      description: "Emit events for updates on existing rows?",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      const rows = await this.fetchRows(25);
      this.emitEvents(rows.reverse());
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    getTsKey() {
      return this.includeUpdates
        ? "updatedAt"
        : "createdAt";
    },
    async fetchRows(maxResults) {
      const rows = [];
      const tsKey = this.getTsKey();
      const lastTs = this._getLastTs();
      let maxTs = lastTs;
      let done = false;

      const params = {
        sortBy: tsKey,
      };

      while (true) {
        const {
          items = [],
          nextPageToken,
        } = await this.coda.findRow(
          null,
          this.docId,
          this.tableId,
          params,
        );
        for (const item of items) {
          const ts = Date.parse(item[tsKey]);
          if (ts > lastTs) {
            rows.push(item);
            if (ts > maxTs) {
              maxTs = ts;
            }
            if (rows.length >= maxResults) {
              done = true;
              break;
            }
          }
          else {
            done = true;
          }
        }
        params.pageToken = nextPageToken;

        if (!nextPageToken || done) {
          this._setLastTs(maxTs);
          return rows;
        }
      }
    },
    rowSummary(row) {
      const name = row.name && ` - ${row.name}` || "";
      return `Row index: ${row.index}` + name;
    },
    emitEvents(events) {
      for (const row of events) {
        const id = this.includeUpdates
          ? `${row.id}-${row.updatedAt}`
          : row.id;

        this.$emit(row, {
          id,
          summary: this.rowSummary(row),
          ts: row.updatedAt,
        });
      }
    },
  },
  async run() {
    const rows = await this.fetchRows();
    this.emitEvents(rows.reverse());
  },
};

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
Coda	`coda`	`app`	This component uses the Coda app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Doc ID	`docId`	`string`	Select a value from the drop down menu.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Include Updated Rows	`includeUpdates`	`boolean`	Emit events for updates on existing rows?

Trigger Authentication#

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

About Coda#

Coda is familiar like a doc and engaging like an app, so your team can jump in quickly, collaborate effectively, and make decisions that stick.

Action#

Send Bot Message on Zoho Cliq

Description:Send message to a bot. [See documentation](https://www.zoho.com/cliq/help/restapi/v2/#Post_Message_Bot)

Version:0.0.2

Key:zoho_cliq-send-bot-message

View on GitHub

Zoho Cliq Overview#

The Zoho Cliq API allows you to automate and integrate your team communication within Zoho Cliq. With this API, you can create bots to send messages, manage channels and users, and streamline notifications to your team about events from other applications or services. Using Pipedream, you can harness these capabilities to create powerful workflows that trigger actions within Zoho Cliq or react to events happening in Cliq to perform tasks in other apps.

Action Code#

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

export default {
  name: "Send Bot Message",
  version: "0.0.2",
  key: "zoho_cliq-send-bot-message",
  description: "Send message to a bot. [See documentation](https://www.zoho.com/cliq/help/restapi/v2/#Post_Message_Bot)",
  type: "action",
  props: {
    app,
    botName: {
      label: "Bot Name",
      description: "The bot name. To get the bot's unique name, go to Settings → Integrations → Bots → Click on the bot name → API EndPoint. For example, if your bot API endpoint is `https://cliq.zoho.com/company/12345/api/v2/bots/pipedreambot/message`, then your bot name is `pipedreambot`.",
      type: "string",
    },
    text: {
      label: "Text",
      description: "The text message",
      type: "string",
    },
    broadcast: {
      label: "Broadcast",
      description: "To broadcast message to all the bot subscribers.",
      type: "boolean",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.sendBotMessage({
      $,
      botName: this.botName,
      data: {
        text: this.text,
        broadcast: this.broadcast,
      },
    });

    $.export("$summary", `Successfully sent message to bot ${this.botName}`); // Empty response from Zoho Cliq

    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
Zoho Cliq	`app`	`app`	This component uses the Zoho Cliq app.
Bot Name	`botName`	`string`	The bot name. To get the bot's unique name, go to Settings → Integrations → Bots → Click on the bot name → API EndPoint. For example, if your bot API endpoint is `https://cliq.zoho.com/company/12345/api/v2/bots/pipedreambot/message`, then your bot name is `pipedreambot`.
Text	`text`	`string`	The text message
Broadcast	`broadcast`	`boolean`	To broadcast message to all the bot subscribers.

Action Authentication#

Zoho Cliq uses OAuth authentication. When you connect your Zoho Cliq account, Pipedream will open a popup window where you can sign into Zoho Cliq and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Cliq API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoCliq.Buddies.READZohoCliq.Webhooks.CREATEZohoCliq.Channels.READZohoCliq.Chats.READZohoCliq.Bots.READZohoCliq.Organisation.READZohoCliq.Reminders.CREATEZohoCliq.Users.READZohoCliq.Messages.READ