List Projects with Clockify API on Card Due Date Reminder from Pipedream API

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

Trigger workflow on

Card Due Date Reminder from the Pipedream 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 Pipedream 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 Card Due Date Reminder trigger
1. Connect your Pipedream account
2. Connect your Pipedream account
3. Select a Board
4. Select a Time Before
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#

Card Due Date Reminder on Pipedream

Description:Emit new event at a specified time before a card is due.

Version:0.1.3

Key:trello-card-due-date-reminder

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import ms from "ms";
import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import constants from "../../common/constants.mjs";
import trello from "../../trello.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "trello-card-due-date-reminder",
  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event at a specified time before a card is due.",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    pipedream: taskScheduler.props.pipedream,
    trello,
    db: "$.service.db",
    http: "$.interface.http",
    board: {
      propDefinition: [
        trello,
        "board",
      ],
    },
    timeBefore: {
      type: "string",
      label: "Time Before",
      description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
      default: "5 minutes",
      options: constants.NOTIFICATION_TIMES,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.timeBefore) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: ms(this.timeBefore) / 1000,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    generateMeta({
      id, name: summary,
    }, now) {
      return {
        id,
        summary,
        ts: now,
      };
    },
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCardIds() {
      return this.db.get("scheduledCardIds");
    },
    _setScheduledCardIds(ids) {
      this.db.set("scheduledCardIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    emitEvent(card, now) {
      const meta = this.generateMeta(card, now);
      this.$emit(card, meta);
    },
  },
  async run(event) {
    const now = event.timestamp * 1000;

    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    let scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, now);
      return;
    }

    // schedule new events
    const scheduledCardIds = this._getScheduledCardIds() || {};
    const cards = await this.trello.getCards({
      boardId: this.board,
    });

    for (const card of cards) {
      const dueDate = card.due
        ? new Date(card.due)
        : null;
      if (!dueDate || dueDate.getTime() < Date.now()) {
        delete scheduledCardIds[card.id];
        continue;
      }

      const later = new Date(dueDate.getTime() - ms(this.timeBefore));

      if (scheduledCardIds[card.id]) {
        // reschedule if card's due date has changed
        if (card.due !== scheduledCardIds[card.id].dueDate) {
          await this.deleteEvent({
            body: {
              id: scheduledCardIds[card.id].eventId,
            },
          });
          scheduledEventIds = scheduledEventIds
            .filter((id) => id !== scheduledCardIds[card.id].eventId);
        } else {
          continue;
        }
      }

      const scheduledEventId = this.emitScheduleEvent(card, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCardIds[card.id] = {
        eventId: scheduledEventId,
        dueDate: card.due,
      };
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCardIds(scheduledCardIds);
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Pipedream	`trello`	`app`	This component uses the Pipedream app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Board	`board`	`string`	Select a value from the drop down menu.
Time Before	`timeBefore`	`string`	Select a value from the drop down menu:`5 minutes10 minutes15 minutes30 minutes1 hour2 hours3 hours6 hours12 hours1 day2 days3 days1 week`

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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`

Try it

Add Task To Project with Clockify API on New Scheduled Tasks from Pipedream API

Pipedream + Clockify

Try it

Create Project with Clockify API on New Scheduled Tasks from Pipedream API

Pipedream + Clockify

Try it

List Time Entries with Clockify API on Card Due Date Reminder from Pipedream API

Pipedream + Clockify

Try it

Get Time Entry Report with Clockify API on Card Due Date Reminder from Pipedream API

Pipedream + Clockify

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it