List Projects with Clockify API on New Message in Channel from Discord Bot API

Pipedream makes it easy to connect APIs for Clockify, Discord Bot and 3,000+ other apps remarkably fast.

Trigger workflow on

New Message in Channel from the Discord Bot API

Next, do this

List Projects with the Clockify 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 Clockify 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. Optional- Configure Ignore Bot Messages
6. Configure timer
Configure the List Projects action
1. Connect your Clockify account
2. Select a Workspace
3. Optional- Configure Name
4. Optional- Configure Strict Name Search
5. Optional- Configure Archived
6. Optional- Configure Billable
7. Optional- Select one or more Clients
8. Optional- Configure Contains Client
9. Optional- Select a Client Status
10. Optional- Select one or more Users
11. Optional- Configure Contains User
12. Optional- Select a User Status
13. Optional- Configure Is Template
14. Optional- Select a Sort Column
15. Optional- Select a Sort Order
16. Optional- Configure Hydrated
17. Optional- Select a Access
18. Optional- Configure Page
19. Optional- Configure Page Size
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:1.0.0

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/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: "1.0.0",

  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,
    },
    ignoreBotMessages: {
      type: "boolean",
      label: "Ignore Bot Messages",
      description: "Set to `true` to only emit messages NOT from the configured Discord bot",
      optional: true,
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      if (this.ignoreBotMessages) {
        const { id } = await this.getBotProfile();
        this._setBotId(id);
      }
    },
  },
  async run({ $ }) {
    // We store a cursor to the last message ID
    let lastMessageIDs = this._getLastMessageIDs();
    const botId = this.ignoreBotMessages
      ? this._getBotId()
      : null;

    // 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;
      }

      if (botId) {
        messages = messages.filter((message) => message.author.id !== botId);
      }

      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
Ignore Bot Messages	`ignoreBotMessages`	`boolean`	Set to `true` to only emit messages NOT from the configured Discord bot
	`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#

List Projects on Clockify

Description:List all projects in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Project/operation/getProjects)

Version:0.0.1

Key:clockify-list-projects

View on GitHub

Clockify Overview#

Clockify is a time tracking and timesheet app that provides a straightforward way to track work hours across projects. With the Clockify API on Pipedream, you can automate time tracking, create detailed reports, manage projects, and sync timesheet data with other apps. Using Pipedream, you can create workflows that trigger on events in Clockify or other apps, process the data, and perform actions like logging time automatically, sending notifications, or creating invoices based on tracked time.

Action Code#

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

export default {
  key: "clockify-list-projects",
  name: "List Projects",
  description: "List all projects in a Clockify workspace. [See the documentation](https://docs.clockify.me/#tag/Project/operation/getProjects)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    clockify,
    workspaceId: {
      propDefinition: [
        clockify,
        "workspaceId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "If provided, you'll get a filtered list of projects that contains the provided string in the project name",
      optional: true,
    },
    strictNameSearch: {
      propDefinition: [
        clockify,
        "strictNameSearch",
      ],
    },
    archived: {
      type: "boolean",
      label: "Archived",
      description: "If set to `true`, you'll only get archived projects",
      optional: true,
    },
    billable: {
      type: "boolean",
      label: "Billable",
      description: "If set to `true`, you'll only get billable projects",
      optional: true,
    },
    clients: {
      propDefinition: [
        clockify,
        "clientId",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      type: "string[]",
      label: "Clients",
      description: "Array of client identifiers",
    },
    containsClient: {
      type: "boolean",
      label: "Contains Client",
      description: "If set to `true`, you'll get a filtered list of projects that contain clients which match the provided id(s) in 'clients' field. If set to `false`, you'll get a filtered list of projects which do NOT contain clients that match the provided id(s) in 'clients' field.",
      optional: true,
    },
    clientStatus: {
      type: "string",
      label: "Client Status",
      description: "Filters projects based on client status provided",
      optional: true,
      options: [
        "ACTIVE",
        "ARCHIVED",
        "ALL",
      ],
    },
    users: {
      propDefinition: [
        clockify,
        "memberIds",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
      label: "Users",
      description: "Array of member/user identifiers",
      optional: true,
    },
    containsUser: {
      type: "boolean",
      label: "Contains User",
      description: "If set to `true`, you'll get a filtered list of projects that contain users which match the provided id(s) in 'users' field. If set to `false`, you'll get a filtered list of projects which do NOT contain users that match the provided id(s) in 'users' field.",
      optional: true,
    },
    userStatus: {
      type: "string",
      label: "User Status",
      description: "Filters projects based on user status provided",
      optional: true,
      options: [
        "PENDING",
        "ACTIVE",
        "DECLINED",
        "INACTIVE",
        "ALL",
      ],
    },
    isTemplate: {
      type: "boolean",
      label: "Is Template",
      description: "Filters projects based on whether they are used as a template or not",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "The column to sort the projects by",
      optional: true,
      options: [
        "ID",
        "NAME",
        "CLIENT_NAME",
        "DURATION",
        "BUDGET",
        "PROGRESS",
      ],
    },
    sortOrder: {
      propDefinition: [
        clockify,
        "sortOrder",
      ],
    },
    hydrated: {
      propDefinition: [
        clockify,
        "hydrated",
      ],
    },
    access: {
      type: "string",
      label: "Access",
      description: "If provided, you'll get a filtered list of projects that matches the provided access",
      optional: true,
      options: [
        "PUBLIC",
        "PRIVATE",
      ],
    },
    page: {
      propDefinition: [
        clockify,
        "page",
      ],
    },
    pageSize: {
      propDefinition: [
        clockify,
        "pageSize",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.clockify.listProjects({
      $,
      workspaceId: this.workspaceId,
      params: {
        "name": this.name,
        "strict-name-search": this.strictNameSearch,
        "archived": this.archived,
        "billable": this.billable,
        "clients": this.clients,
        "contains-client": this.containsClient,
        "client-status": this.clientStatus,
        "users": this.users,
        "contains-user": this.containsUser,
        "user-status": this.userStatus,
        "is-template": this.isTemplate,
        "sort-column": this.sortColumn,
        "sort-order": this.sortOrder,
        "hydrated": this.hydrated,
        "access": this.access,
        "page": this.page,
        "page-size": this.pageSize,
      },
    });

    $.export("$summary", `Successfully listed ${response.length} projects in the workspace`);

    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
Clockify	`clockify`	`app`	This component uses the Clockify app.
Workspace	`workspaceId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	If provided, you'll get a filtered list of projects that contains the provided string in the project name
Strict Name Search	`strictNameSearch`	`boolean`	Flag to toggle on/off strict search mode
Archived	`archived`	`boolean`	If set to `true`, you'll only get archived projects
Billable	`billable`	`boolean`	If set to `true`, you'll only get billable projects
Clients	`clients`	`string[]`	Select a value from the drop down menu.
Contains Client	`containsClient`	`boolean`	If set to `true`, you'll get a filtered list of projects that contain clients which match the provided id(s) in 'clients' field. If set to `false`, you'll get a filtered list of projects which do NOT contain clients that match the provided id(s) in 'clients' field.
Client Status	`clientStatus`	`string`	Select a value from the drop down menu:`ACTIVEARCHIVEDALL`
Users	`users`	`string[]`	Select a value from the drop down menu.
Contains User	`containsUser`	`boolean`	If set to `true`, you'll get a filtered list of projects that contain users which match the provided id(s) in 'users' field. If set to `false`, you'll get a filtered list of projects which do NOT contain users that match the provided id(s) in 'users' field.
User Status	`userStatus`	`string`	Select a value from the drop down menu:`PENDINGACTIVEDECLINEDINACTIVEALL`
Is Template	`isTemplate`	`boolean`	Filters projects based on whether they are used as a template or not
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`IDNAMECLIENT_NAMEDURATIONBUDGETPROGRESS`
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`ASCENDINGDESCENDING`
Hydrated	`hydrated`	`boolean`	If set to `true`, you'll get a hydrated response with additional information
Access	`access`	`string`	Select a value from the drop down menu:`PUBLICPRIVATE`
Page	`page`	`integer`	The page number to return. Default is `1`
Page Size	`pageSize`	`integer`	The number of results to return. Default is `100`

Action Authentication#

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

About Clockify#

100% Free Time Tracking Software

More Ways to Connect Clockify + Discord Bot#

Other Popular Integrations#

Add Task To Project with Clockify API on New Forum Thread Message from Discord Bot API

Discord Bot + Clockify

List Projects with Clockify API on New Message in Channel from Discord Bot API

Pipedream makes it easy to connect APIs for Clockify, Discord Bot and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular