Create Note with Cloze API on New Keyword Mention (Instant) from Slack API

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

Trigger workflow on

New Keyword Mention (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Keyword Mention (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Configure Keyword
5. Optional- Configure Ignore Bots
Configure the Create Note action
1. Connect your Cloze account
2. Configure Unique ID
3. Configure Source
4. Optional- Configure Date
5. Optional- Configure From
6. Optional- Configure Subject
7. Configure Body
8. Optional- Configure Additional Data
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 Keyword Mention (Instant) on Slack

Description:Emit new event when a specific keyword is mentioned in a channel

Version:0.0.5

Key:slack-new-keyword-mention

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

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

export default {
  ...common,
  key: "slack-new-keyword-mention",
  name: "New Keyword Mention (Instant)",
  version: "0.0.5",
  description: "Emit new event when a specific keyword is mentioned in a channel",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    keyword: {
      propDefinition: [
        common.props.slack,
        "keyword",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      // emit historical events
      const messages = await this.getMatches({
        query: this.keyword,
        sort: "timestamp",
      });
      const filteredMessages = this.conversations?.length > 0
        ? messages.filter((message) => this.conversations.includes(message.channel.id))
        : messages;
      await this.emitHistoricalEvents(filteredMessages.slice(-25).reverse());
    },
  },
  methods: {
    ...common.methods,
    async getMatches(params) {
      return (await this.slack.searchMessages(params)).messages.matches || [];
    },
    async emitHistoricalEvents(messages) {
      for (const message of messages) {
        const event = await this.processEvent({
          ...message,
          subtype: message.subtype || constants.SUBTYPE.PD_HISTORY_MESSAGE,
        });
        if (event) {
          if (!event.client_msg_id) {
            event.pipedream_msg_id = `pd_${Date.now()}_${Math.random().toString(36)
              .substr(2, 10)}`;
          }

          this.$emit(event, {
            id: event.client_msg_id || event.pipedream_msg_id,
            summary: this.getSummary(event),
            ts: event.event_ts || Date.now(),
          });
        }
      }
    },
    getSummary() {
      return "New keyword mention received";
    },
    async processEvent(event) {
      const {
        type: msgType,
        subtype,
        bot_id: botId,
        text,
      } = event;

      if (msgType !== "message") {
        console.log(`Ignoring event with unexpected type "${msgType}"`);
        return;
      }

      // This source is designed to just emit an event for each new message received.
      // Due to inconsistencies with the shape of message_changed and message_deleted
      // events, we are ignoring them for now. If you want to handle these types of
      // events, feel free to change this code!!
      if (subtype && !constants.ALLOWED_SUBTYPES.includes(subtype)) {
        console.log(`Ignoring message with subtype. "${subtype}"`);
        return;
      }

      if ((this.ignoreBot) && (subtype === constants.SUBTYPE.BOT_MESSAGE || botId)) {
        return;
      }

      let emitEvent = false;
      if (text.indexOf(this.keyword) !== -1) {
        emitEvent = true;
      } else if (subtype === constants.SUBTYPE.PD_HISTORY_MESSAGE) {
        emitEvent = true;
      }

      if (emitEvent) {
        return event;
      }
    },
  },
  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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Keyword	`keyword`	`string`	Keyword to monitor
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Action#

Create Note on Cloze

Description:Creates a note in Cloze. [See the documentation](https://api.cloze.com/api-docs/#!/Content/post_v1_createcontent).

Version:0.0.1

Key:cloze-create-note

View on GitHub

Cloze Overview#

The Cloze API enables you to access and manage your Cloze CRM data programmatically. In Pipedream, you can create powerful, serverless workflows that react to events or run on schedules to automate tasks involving Cloze data. You could synchronize contacts, track communication history, or trigger actions based on updates in Cloze. By leveraging Pipedream's capacity to connect to a myriad of services, you can create multi-step workflows that involve other apps to streamline your business processes and harness the full potential of CRM automation.

Action Code#

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

export default {
  key: "cloze-create-note",
  name: "Create Note",
  description: "Creates a note in Cloze. [See the documentation](https://api.cloze.com/api-docs/#!/Content/post_v1_createcontent).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    uniqueId: {
      type: "string",
      label: "Unique ID",
      description: "A unique identifier for this content record. This will often be the unique Id in an external system so that updates can be matched up with the record in Cloze.",
    },
    source: {
      type: "string",
      label: "Source",
      description: "The source that this content record originally came from (Eg. `todoist.com`). Must be a valid domain.",
    },
    date: {
      type: "string",
      label: "Date",
      description: "When the content should show up in the timeline. Can be a string or a UTC timestamp in ms since the epoch. Eg. `2021-01-01` or `1609459200000`.",
      optional: true,
    },
    from: {
      type: "string",
      label: "From",
      description: "From address for this content record (the address of the person created the record). This can be an email address, phone number, social handle or app link (Eg. `na16.salesforce.com:006j000000Pkp1d`)",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Subject of the communication record.",
      optional: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "Body text of the communication record.",
    },
    additionalData: {
      type: "object",
      label: "Additional Data",
      description: "Additional details for the note in JSON format. [See the documentation](https://api.cloze.com/api-docs/#!/Content/post_v1_createcontent).",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      uniqueId,
      date,
      from,
      source,
      subject,
      body,
      additionalData,
    } = this;

    const response = await app.addContentRecord({
      $,
      data: {
        uniqueid: uniqueId,
        date,
        style: "note",
        from,
        source,
        subject,
        body,
        ...additionalData,
      },
    });

    $.export("$summary", "Successfully created note.");

    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
Cloze	`app`	`app`	This component uses the Cloze app.
Unique ID	`uniqueId`	`string`	A unique identifier for this content record. This will often be the unique Id in an external system so that updates can be matched up with the record in Cloze.
Source	`source`	`string`	The source that this content record originally came from (Eg. `todoist.com`). Must be a valid domain.
Date	`date`	`string`	When the content should show up in the timeline. Can be a string or a UTC timestamp in ms since the epoch. Eg. `2021-01-01` or `1609459200000`.
From	`from`	`string`	From address for this content record (the address of the person created the record). This can be an email address, phone number, social handle or app link (Eg. `na16.salesforce.com:006j000000Pkp1d`)
Subject	`subject`	`string`	Subject of the communication record.
Body	`body`	`string`	Body text of the communication record.
Additional Data	`additionalData`	`object`	Additional details for the note in JSON format. See the documentation.

Action Authentication#

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

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

Create Note with Cloze API on New Keyword Mention (Instant) from Slack API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular