Get Definitions with Clearly Defined API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Get Definitions 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 Slack 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 Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the Get Definitions action
1. Connect your Clearly Defined account
2. Optional- Configure Pattern
3. Optional- Select a Type
4. Optional- Select a Provider
5. Optional- Configure Namespace
6. Optional- Configure Name
7. Optional- Configure License
8. Optional- Configure Released After
9. Optional- Configure Released Before
10. Optional- Configure Min Licensed Score
11. Optional- Configure Max Licensed Score
12. Optional- Configure Min Described Score
13. Optional- Configure Max Described Score
14. Optional- Select a Sort
15. Optional- Select a Sort Direction
16. Optional- Configure Continuation Token
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 Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.23

Key:slack-new-message-in-channels

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-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.23",
  description: "Emit new event when a new message is posted to one or more channels",
  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",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // 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!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      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`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

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#

Get Definitions on Clearly Defined

Description:Gets the coordinates for all definitions that match the given pattern in the specified part of the definition. [See the documentation](https://api.clearlydefined.io/api-docs/#/definitions/get_definitions).

Version:0.0.1

Key:clearly_defined-get-definitions

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-definitions",
  name: "Get Definitions",
  description: "Gets the coordinates for all definitions that match the given pattern in the specified part of the definition. [See the documentation](https://api.clearlydefined.io/api-docs/#/definitions/get_definitions).",
  version: "0.0.1",
  type: "action",
  props: {
    clearlyDefined,
    pattern: {
      type: "string",
      label: "Pattern",
      description: "The string to search for in definition coordinates to get coordinate suggestions",
      optional: true,
    },
    type: {
      propDefinition: [
        clearlyDefined,
        "type",
      ],
      optional: true,
    },
    provider: {
      propDefinition: [
        clearlyDefined,
        "provider",
      ],
      optional: true,
    },
    namespace: {
      propDefinition: [
        clearlyDefined,
        "namespace",
      ],
      optional: true,
    },
    name: {
      propDefinition: [
        clearlyDefined,
        "name",
      ],
      optional: true,
    },
    license: {
      type: "string",
      label: "License",
      description: "The SPDX license identifier",
      optional: true,
    },
    releasedAfter: {
      type: "string",
      label: "Released After",
      description: "The minimum release date for the component. E.g. `2025-01-01`",
      optional: true,
    },
    releasedBefore: {
      type: "string",
      label: "Released Before",
      description: "The maximum release date for the component. E.g. `2025-01-01`",
      optional: true,
    },
    minLicensedScore: {
      type: "integer",
      label: "Min Licensed Score",
      description: "The minimum effective licensed score for the component",
      optional: true,
    },
    maxLicensedScore: {
      type: "integer",
      label: "Max Licensed Score",
      description: "The maximum effective licensed score for the component",
      optional: true,
    },
    minDescribedScore: {
      type: "integer",
      label: "Min Described Score",
      description: "The minimum effective described score for the component",
      optional: true,
    },
    maxDescribedScore: {
      type: "integer",
      label: "Max Described Score",
      description: "The maximum effective described score for the component",
      optional: true,
    },
    sort: {
      propDefinition: [
        clearlyDefined,
        "sort",
      ],
    },
    sortDirection: {
      propDefinition: [
        clearlyDefined,
        "sortDirection",
      ],
    },
    continuationToken: {
      type: "string",
      label: "Continuation Token",
      description: "Used for pagination. Seeded from the results of the previous query",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.clearlyDefined.getDefinitions({
      $,
      params: {
        pattern: this.pattern,
        type: this.type,
        provider: this.provider,
        name: this.name,
        namespace: this.namespace,
        license: this.license,
        releasedAfter: this.releasedAfter,
        releasedBefore: this.releasedBefore,
        minLicensedScore: this.minLicensedScore,
        maxLicensedScore: this.maxLicensedScore,
        minDescribedScore: this.minDescribedScore,
        maxDescribedScore: this.maxDescribedScore,
        sort: this.sort,
        sortDesc: this.sortDirection === "descending",
        continuationToken: this.continuationToken,
      },
    });

    const length = response.data
      ? response.data.length
      : response.length
        ? response.length
        : 0;

    $.export("$summary", `Successfully retrieved ${length} definition${length === 1
      ? ""
      : "s"}`);

    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.
Pattern	`pattern`	`string`	The string to search for in definition coordinates to get coordinate suggestions
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
License	`license`	`string`	The SPDX license identifier
Released After	`releasedAfter`	`string`	The minimum release date for the component. E.g. `2025-01-01`
Released Before	`releasedBefore`	`string`	The maximum release date for the component. E.g. `2025-01-01`
Min Licensed Score	`minLicensedScore`	`integer`	The minimum effective licensed score for the component
Max Licensed Score	`maxLicensedScore`	`integer`	The maximum effective licensed score for the component
Min Described Score	`minDescribedScore`	`integer`	The minimum effective described score for the component
Max Described Score	`maxDescribedScore`	`integer`	The maximum effective described score for the component
Sort	`sort`	`string`	Select a value from the drop down menu:`typeprovidernamespacenamerevisionlicensereleaseDatelicensedScoredescribedScoreeffectiveScoretoolScore`
Sort Direction	`sortDirection`	`string`	Select a value from the drop down menu:`ascendingdescending`
Continuation Token	`continuationToken`	`string`	Used for pagination. Seeded from the results of the previous query

Get Definitions with Clearly Defined API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Clearly Defined, Slack 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