Get Harvests with Clearly Defined API on New Message in Channel from Discord Bot API

Pipedream makes it easy to connect APIs for Clearly Defined, Discord Bot and 2,500+ other apps remarkably fast.

Trigger workflow on

New Message in Channel from the Discord Bot API

Next, do this

Get Harvests with the Clearly Defined 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 Discord Bot trigger and Clearly Defined 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 in Channel trigger
1. Connect your Discord Bot account
2. Select a Guild
3. Select one or more Channels
4. Optional- Configure Emit messages as a single event
5. Configure timer
Configure the Get Harvests action
1. Connect your Clearly Defined account
2. Select a Type
3. Select a Provider
4. Configure Namespace
5. Configure Name
6. Optional- Configure Revision
7. Optional- Select a Form
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 in Channel on Discord Bot

Description:Emit new event for each message posted to one or more channels

Version:0.0.18

Key:discord_bot-new-message-in-channel

View on GitHub

Discord Bot Overview#

The Discord Bot API unlocks the power to interact with Discord users and channels programmatically, making it possible to automate messages, manage servers, and integrate with other services. With Pipedream's serverless platform, you can create complex workflows that respond to events in Discord, process data, and trigger actions in other apps. This opens up opportunities for community engagement, content moderation, analytics, and more, without the overhead of managing infrastructure.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import maxBy from "lodash.maxby";
import common from "../common.mjs";
import sampleEmit from "./test-event.mjs";

const { discord } = common.props;

export default {
  ...common,
  key: "discord_bot-new-message-in-channel",
  name: "New Message in Channel",
  description: "Emit new event for each message posted to one or more channels",
  type: "source",
  version: "0.0.18",

  dedupe: "unique", // Dedupe events based on the Discord message ID
  props: {
    ...common.props,
    db: "$.service.db",
    channels: {
      type: "string[]",
      label: "Channels",
      description: "The channels you'd like to watch for new messages",
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit messages as a single event",
      description:
        "If `true`, all messages are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each Discord message as its own event in Pipedream",
      optional: true,
      default: false,
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    // We store a cursor to the last message ID
    let lastMessageIDs = this._getLastMessageIDs();

    // If this is our first time running this source,
    // get the last N messages, emit them, and checkpoint
    for (const channelId of this.channels) {
      let lastMessageID;
      let messages = [];

      if (!lastMessageID) {
        messages = await this.discord.getMessages({
          $,
          channelId,
          params: {
            limit: 100,
          },
        });

        lastMessageID = messages.length
          ? maxBy(messages, (message) => message.id).id
          : 1;

      } else {
        let newMessages = [];

        do {
          newMessages = await this.discord.getMessages({
            $,
            channelId,
            params: {
              after: lastMessageIDs[channelId],
            },
          });

          messages = messages.concat(newMessages);

          lastMessageID = newMessages.length
            ? maxBy(newMessages, (message) => message.id).id
            : lastMessageIDs[channelId];

        } while (newMessages.length);
      }

      // Set the new high water mark for the last message ID
      // for this channel
      lastMessageIDs[channelId] = lastMessageID;

      if (!messages.length) {
        console.log(`No new messages in channel ${channelId}`);
        return;
      }

      console.log(`${messages.length} new messages in channel ${channelId}`);

      // Batched emits do not take advantage of the built-in deduper
      if (this.emitEventsInBatch) {
        const suffixChar =
          messages.length > 1
            ? "s"
            : "";

        this.$emit(messages, {
          summary: `${messages.length} new message${suffixChar}`,
          id: lastMessageID,
        });

      } else {
        messages.forEach((message) => {
          this.$emit(message, {
            summary: message.content,
            id: message.id, // dedupes events based on this ID
          });
        });
      }
    }

    // Set the last message ID for the next run
    this._setLastMessageIDs(lastMessageIDs);
  },
  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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`channels`	`string[]`	Select a value from the drop down menu.
Emit messages as a single event	`emitEventsInBatch`	`boolean`	If `true`, all messages are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each Discord message as its own event in Pipedream
	`timer`	`$.interface.timer`

Trigger Authentication#

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

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

Action#

Get Harvests on Clearly Defined

Description:Get all the harvested data for a component revision. [See the documentation](https://api.clearlydefined.io/api-docs/#/harvest/get_harvest__type___provider___namespace___name___revision_).

Version:0.0.1

Key:clearly_defined-get-harvests

View on GitHub

Clearly Defined Overview#

The Clearly Defined API offers a way to interact with the Clearly Defined service, which curates and shares data about the clarity of licenses and security of open source components. You can retrieve detailed information about software components' licenses, scores for clarity, and metadata. On Pipedream, you can harness this API to automate checking the compliance and security of software dependencies, notify pertinent stakeholders about the status of components, and integrate with other tools for a seamless open source governance process.

Action Code#

import clearlyDefined from "../../clearly_defined.app.mjs";

export default {
  key: "clearly_defined-get-harvests",
  name: "Get Harvests",
  description: "Get all the harvested data for a component revision. [See the documentation](https://api.clearlydefined.io/api-docs/#/harvest/get_harvest__type___provider___namespace___name___revision_).",
  version: "0.0.1",
  type: "action",
  props: {
    clearlyDefined,
    type: {
      propDefinition: [
        clearlyDefined,
        "type",
      ],
    },
    provider: {
      propDefinition: [
        clearlyDefined,
        "provider",
      ],
    },
    namespace: {
      propDefinition: [
        clearlyDefined,
        "namespace",
      ],
    },
    name: {
      propDefinition: [
        clearlyDefined,
        "name",
      ],
    },
    revision: {
      propDefinition: [
        clearlyDefined,
        "revision",
      ],
    },
    form: {
      propDefinition: [
        clearlyDefined,
        "form",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.clearlyDefined.getHarvests({
      $,
      type: this.type,
      provider: this.provider,
      name: this.name,
      namespace: this.namespace,
      revision: this.revision,
      params: {
        form: this.form,
      },
    });

    if (response && Object.keys(response).length > 0) {
      $.export("$summary", "Successfully retrieved harvest details");
    }

    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
Clearly Defined	`clearlyDefined`	`app`	This component uses the Clearly Defined app.
Type	`type`	`string`	Select a value from the drop down menu:`composercondacondasrccratedebdebsrcgemgitgomavennpmnugetpodpypisourcearchive`
Provider	`provider`	`string`	Select a value from the drop down menu:`anaconda-mainanaconda-rcocoapodsconda-forgecratesiodebiangithubgitlabmavencentralmavengooglegradlepluginnpmjsnugetpackagistpypirubygems`
Namespace	`namespace`	`string`	Many component systems have namespaces. GitHub orgs, NPM namespace, Maven group id, Conda Subdir/Architecture. If your component does not have a namespace, use '-' (ASCII hyphen).
Name	`name`	`string`	The name of the component you want
Revision	`revision`	`string`	Components typically have some differentiator like a version or commit id. Use that here. If this segment is omitted, the latest revision is used (if that makes sense for the provider).
Form	`form`	`string`	Select a value from the drop down menu:`{ "label": "summarize harvested file", "value": "summary" }{ "label": "raw content of the harvested file", "value": "raw" }{ "label": "streamed content of the harvested file", "value": "streamed" }{ "label": "List of matching harvested files", "value": "list" }`

Action Authentication#

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

About Clearly Defined#

Helping FOSS projects be more successful through clearly defined project data.

More Ways to Connect Clearly Defined + Discord Bot#

Other Popular Integrations#

Get Definitions with Clearly Defined API on New Guild Member from Discord Bot API

Discord Bot + Clearly Defined

Get Harvests with Clearly Defined API on New Message in Channel from Discord Bot API

Pipedream makes it easy to connect APIs for Clearly Defined, Discord Bot and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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