List Projects with Clockify API on New Upcoming Event Alert from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert from the Google Calendar 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 Google Calendar 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 Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Configure Pipedream API Key
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes 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#

New Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar.

Version:0.1.0

Key:google_calendar-upcoming-event-alert

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Trigger Code#

import googleCalendar from "../../google_calendar.app.mjs";
import taskScheduler from "../common/taskScheduler.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: "Emit new event based on a time interval before an upcoming event in the calendar.",
  version: "0.1.0",
  type: "source",
  props: {
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    pipedreamApiKey: {
      type: "string",
      label: "Pipedream API Key",
      description: "[Click here to find your Pipedream API key](https://pipedream.com/settings/user)",
      secret: true,
    },
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteScheduledEvent({
          body: {
            id,
          },
        }, this.pipedreamApiKey)) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe(this.pipedreamApiKey);
    }

    const 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, `Upcoming ${event.summary
        ? event.summary + " "
        : ""}event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  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
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar 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.
Pipedream API Key	`pipedreamApiKey`	`string`	Click here to find your Pipedream API key
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

Trigger Authentication#

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

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

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonlyemailprofile

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

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 + Google Calendar#

Other Popular Integrations#

Add Members To Project with Clockify API on New Cancelled Event from Google Calendar API

Google Calendar + Clockify

List Projects with Clockify API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Clockify, Google Calendar 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