Get Users with ChatBot API on New Comment (Instant) from Figma API

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

Trigger workflow on

New Comment (Instant) from the Figma API

Next, do this

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

Select this integration
Configure the New Comment (Instant) trigger
1. Configure alert
2. Connect your Figma account
Configure the Get Users action
1. Connect your ChatBot account
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 Comment (Instant) on Figma

Description:Emit new event when someone comments on a file

Version:0.0.3

Key:figma-new-comment

View on GitHub

Figma Overview#

The Figma API unlocks the power to automate and integrate design workflows, enabling both designers and developers to extract assets, update designs, and manage files programmatically. By leveraging the Figma API on Pipedream, you can create automated processes that sync design updates with other tools, notify team members of changes, or feed design information into other parts of your digital ecosystem.

Trigger Code#

import { ConfigurationError } from "@pipedream/platform";
import { v4 as uuid } from "uuid";
import common from "../../common/common.mjs";

export default {
  ...common,
  key: "figma-new-comment",
  name: "New Comment (Instant)",
  description: "Emit new event when someone comments on a file",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    alert: {
      type: "alert",
      alertType: "info",
      content: "A Figma Organization Plan or higher is required to use webhooks. See Figma's [pricing page](https://www.figma.com/pricing) for more details.",
    },
    ...common.props,
    http: "$.interface.http",
    db: "$.service.db",
  },
  hooks: {
    async activate() {
      try {
        const passcode = uuid();
        this.setPasscode(passcode);

        const hookId = await this.figmaApp.createHook(
          "FILE_COMMENT",
          this.getTeamId(),
          this.http.endpoint,
          passcode,
        );

        this.setHookId(hookId);
      } catch (error) {
        if (error.response.status === 400) {
          throw new ConfigurationError("A Figma Organization Plan or higher is required to use webhooks. See Figma's [pricing page](https://www.figma.com/pricing) for more details.");
        }
        throw error;
      }
    },
    async deactivate() {
      await this.figmaApp.deleteHook(this.getHookId());
    },
  },
  methods: {
    ...common.methods,
    getHookId() {
      return this.db.get("hookId");
    },
    setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    getPasscode() {
      return this.db.get("passcode");
    },
    setPasscode(passcode) {
      this.db.set("passcode", passcode);
    },
  },
  async run(event) {
    this.http.respond({
      status: 200,
    });

    if (event.body.passcode === this.getPasscode()) {
      this.$emit(event.body, {
        summary: `New comment on a file (${event.body.comment_id})`,
        id: event.body.comment_id,
        ts: event.body.timestamp,
      });
    }
  },
};

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
Figma	`figmaApp`	`app`	This component uses the Figma app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

file_read

About Figma#

Figma is the leading collaborative design tool for building meaningful products.

Action#

Get Users on ChatBot

Description:Get a list of users. [See docs here](https://www.chatbot.com/docs/users/#list-users)

Version:0.0.1

Key:chatbot-get-users

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.

Action Code#

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

export default {
  key: "chatbot-get-users",
  name: "Get Users",
  description: "Get a list of users. [See docs here](https://www.chatbot.com/docs/users/#list-users)",
  version: "0.0.1",
  type: "action",
  props: {
    chatbot,
  },
  async run({ $ }) {
    const response = await this.chatbot.getUsers({
      $,
    });

    $.export("$summary", "Successfully retrieved users");

    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
ChatBot	`chatbot`	`app`	This component uses the ChatBot app.

Action 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,