New Upcoming Event Alert (Polling) from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert (Polling) from the Google Calendar API

Next, do this

Connect to 3,000+ APIs using code and no-code building blocks

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#

Trigger a workflow on New Upcoming Event Alert (Polling) with Google Calendar API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Upcoming Event Alert (Polling) trigger
1. Connect your Google Calendar account
2. Configure timer
3. Configure pollingInfo
4. Optional- Select a Calendar ID
5. Optional- Select one or more Event Types
6. Configure Minutes Before
Add steps to connect to 3,000+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

New Upcoming Event Alert (Polling) on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/list)

Version:0.0.1

Key:google_calendar-upcoming-event-alert-polling

View on GitHub

Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "google_calendar-upcoming-event-alert-polling",
  name: "New Upcoming Event Alert (Polling)",
  description: "Emit new event based on a time interval before an upcoming event in the calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/list)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    pollingInfo: {
      type: "alert",
      alertType: "info",
      content: "Since this source executes based on a timer, event emission may be slightly delayed. For example, if the source runs every 5 minutes, the delay may be up to 5 minutes. You can use the `upcoming-event-alert` source for instant event emission.",
    },
    calendarId: {
      propDefinition: [
        common.props.googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        common.props.googleCalendar,
        "eventTypes",
      ],
    },
    minutesBefore: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      default: 30,
    },
  },
  methods: {
    ...common.methods,
    _getEmittedEvents() {
      return this.db.get("emittedEvents") || {};
    },
    _setEmittedEvents(emittedEvents) {
      this.db.set("emittedEvents", emittedEvents);
    },
    _cleanupEmittedEvents(now) {
      const emittedEvents = this._getEmittedEvents();
      const cleanedEvents = {};
      let cleanedCount = 0;

      // Keep only events that haven't passed yet
      for (const [
        eventId,
        startTime,
      ] of Object.entries(emittedEvents)) {
        if (startTime > now.getTime()) {
          cleanedEvents[eventId] = startTime;
        } else {
          cleanedCount++;
        }
      }

      if (cleanedCount > 0) {
        console.log(`Cleaned up ${cleanedCount} past event(s) from emitted events tracker`);
        this._setEmittedEvents(cleanedEvents);
      }

      return cleanedEvents;
    },
    getConfig({ now }) {
      // Get events starting from now up to the alert window
      const timeMin = now.toISOString();
      // Look ahead to find events within our alert window
      const alertWindowMs = this.minutesBefore * 60 * 1000;
      const timeMax = new Date(now.getTime() + alertWindowMs).toISOString();

      return {
        calendarId: this.calendarId,
        timeMin,
        timeMax,
        eventTypes: this.eventTypes,
        singleEvents: true,
        orderBy: "startTime",
      };
    },
    isRelevant(event, { now }) {
      // Skip cancelled events
      if (event.status === "cancelled") {
        return false;
      }

      // Get event start time
      const startTime = event.start
        ? new Date(event.start.dateTime || event.start.date)
        : null;

      if (!startTime) {
        return false;
      }

      // Calculate time remaining until event starts (in milliseconds)
      const timeRemaining = startTime.getTime() - now.getTime();

      // Skip past events
      if (timeRemaining < 0) {
        return false;
      }

      // Convert minutesBefore to milliseconds
      const alertThresholdMs = this.minutesBefore * 60 * 1000;

      // Clean up old emitted events and get the current list
      const emittedEvents = this._cleanupEmittedEvents(now);

      // Check if we've already emitted this event
      if (emittedEvents[event.id]) {
        return false;
      }

      // Emit if time remaining is less than or equal to the alert threshold
      if (timeRemaining <= alertThresholdMs) {
        // Mark this event as emitted with its start time for future cleanup
        emittedEvents[event.id] = startTime.getTime();
        this._setEmittedEvents(emittedEvents);
        return true;
      }

      return false;
    },
    generateMeta(event) {
      const {
        summary,
        id,
      } = event;
      return {
        summary: `Upcoming: ${summary || `Event ID: ${id}`}`,
        id: `${id}-${Date.now()}`,
        ts: Date.now(),
      };
    },
  },
  hooks: {
    async deploy() {
      // On initial deploy, don't emit historical events
      // Just initialize the emitted events tracker
      this._setEmittedEvents({});
    },
  },
  sampleEmit,
};

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.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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	`minutesBefore`	`integer`	Number of minutes to trigger before the start of the calendar event.

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.

More Ways to Use Google Calendar#

Triggers#

New Upcoming Event Alert from the Google Calendar API

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

Try it

New Created or Updated Event (Instant) from the Google Calendar API

Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)

Try it

New Calendar Created from the Google Calendar API

Emit new event when a calendar is created.

Try it

New Event Matching a Search from the Google Calendar API

Emit new event when a Google Calendar event is created that matches a search

Try it

New Cancelled Event from the Google Calendar API

Emit new event when a Google Calendar event is cancelled or deleted

Try it

Actions#

Add Attendees To Event with the Google Calendar API

Add attendees to an existing event. See the documentation

Try it

Add Quick Event with the Google Calendar API

Create a quick event to the Google Calendar. See the documentation

Try it

Create Event with the Google Calendar API

Create an event in a Google Calendar. See the documentation

Try it

Delete an Event with the Google Calendar API

Delete an event from a Google Calendar. See the documentation

Try it

Get Current User with the Google Calendar API

Retrieve information about the authenticated Google Calendar account, including the primary calendar (summary, timezone, ACL flags), a list of accessible calendars, user-level settings (timezone, locale, week start), and the color palette that controls events and calendars. Ideal for confirming which calendar account is in use, customizing downstream scheduling, or equipping LLMs with the user’s context (timezones, available calendars) prior to creating or updating events. See the documentation

Try it