Create Event with Google Calendar API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Google Calendar, Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Labeled Email from the Gmail API

Next, do this

Create Event with the Google Calendar 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 Gmail trigger and Google Calendar action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Labeled Email trigger
1. Configure timer
2. Connect your Gmail account
3. Select a Label
Configure the Create Event action
1. Connect your Google Calendar account
2. Select a Type of Add
3. Optional- Select a Calendar ID
4. Configure Describe Event
5. Optional- Configure Event Title
6. Optional- Select a Color ID
7. Optional- Select a Time Zone
8. Optional- Select a Send Updates
9. Optional- Configure Create Meet Room
10. Optional- Select a Visibility
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 Labeled Email on Gmail

Description:Emit new event when a new email is labeled.

Version:0.0.6

Key:gmail-new-labeled-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "gmail-new-labeled-email",
  name: "New Labeled Email",
  description: "Emit new event when a new email is labeled.",
  type: "source",
  version: "0.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    label: {
      propDefinition: [
        gmail,
        "label",
      ],
    },
  },
  methods: {
    ...common.methods,
    getHistoryTypes() {
      return [
        "labelAdded",
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: `${message.id}-${this.label}`,
        summary: `A new message with ID: ${message.id} was labeled with "${this.label}"`,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return history.filter((item) =>
        (item.labelsAdded && item.labelsAdded[0].labelIds.includes(this.label))
        || (item.messagesAdded
          && item.messagesAdded[0].message.labelIds
          && item.messagesAdded[0].message.labelIds.includes(this.label)));
    },
  },
  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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Label	`label`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Create Event on Google Calendar

Description:Create an event in a Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/insert)

Version:0.2.4

Key:google_calendar-create-event

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.

Action Code#

import googleCalendar from "../../google_calendar.app.mjs";
import createEventCommon from "../common/create-event-common.mjs";
import { v4 as uuidv4 } from "uuid";
import constants from "../../common/constants.mjs";

export default {
  key: "google_calendar-create-event",
  name: "Create Event",
  description: "Create an event in a Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/insert)",
  version: "0.2.4",
  type: "action",
  props: {
    googleCalendar,
    addType: {
      type: "string",
      label: "Type of Add",
      description: "Whether to perform a quick add or a detailed event",
      options: [
        {
          label: "Add Detailed Event",
          value: "detailed",
        },
        {
          label: "Add Quick Event using Natural Language",
          value: "quick",
        },
      ],
      reloadProps: true,
    },
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    text: {
      type: "string",
      label: "Describe Event",
      description: "Write a plain text description of event, and Google will parse this string to create the event. eg. 'Meet with Michael 10am 7/22/2024' or 'Call Sarah at 1:30PM on Friday'",
      hidden: true,
    },
    summary: {
      label: "Event Title",
      type: "string",
      description: "Enter a title for the event, (e.g., `My event`)",
      optional: true,
      hidden: true,
    },
    colorId: {
      propDefinition: [
        googleCalendar,
        "colorId",
      ],
      hidden: true,
    },
    timeZone: {
      propDefinition: [
        googleCalendar,
        "timeZone",
      ],
      hidden: true,
    },
    sendUpdates: {
      propDefinition: [
        googleCalendar,
        "sendUpdates",
      ],
      hidden: true,
    },
    createMeetRoom: {
      type: "boolean",
      label: "Create Meet Room",
      description: "Whether to create a Google Meet room for this event.",
      optional: true,
      hidden: true,
    },
    visibility: {
      type: "string",
      label: "Visibility",
      description: "Visibility of the event",
      options: [
        "default",
        "public",
        "private",
        "confidential",
      ],
      optional: true,
      hidden: true,
    },
  },
  async additionalProps(props) {
    const isDetailed = this.addType === "detailed";

    props.text.hidden = isDetailed;

    props.summary.hidden = !isDetailed;
    props.colorId.hidden = !isDetailed;
    props.timeZone.hidden = !isDetailed;
    props.sendUpdates.hidden = !isDetailed;
    props.createMeetRoom.hidden = !isDetailed;
    props.visibility.hidden = !isDetailed;

    if (isDetailed) {
      const commonProps = createEventCommon.props({
        isUpdate: false,
      });
      if (this.repeatFrequency) {
        const frequency = constants.REPEAT_FREQUENCIES[this.repeatFrequency];
        commonProps.repeatInterval.description = `Enter 1 to "repeat every ${frequency}", enter 2 to "repeat every other ${frequency}", etc. Defaults to 1.`;
        commonProps.repeatInterval.hidden = !this.repeatFrequency;
        commonProps.repeatUntil.hidden = !this.repeatFrequency;
        commonProps.repeatTimes.hidden = !this.repeatFrequency;
      }
      return commonProps;
    }
    return {};
  },
  methods: {
    ...createEventCommon.methods,
  },
  async run({ $ }) {
    if (this.addType === "quick") {
      const quickResponse = await this.googleCalendar.quickAddEvent({
        calendarId: this.calendarId,
        text: this.text,
      });
      $.export("$summary", `Successfully added a quick event: "${quickResponse.id}"`);
      return quickResponse;
    }

    const timeZone = await this.getTimeZone(this.timeZone);
    const attendees = this.formatAttendees(this.attendees);
    const recurrence = this.formatRecurrence({
      repeatFrequency: this.repeatFrequency,
      repeatInterval: this.repeatInterval,
      repeatTimes: this.repeatTimes,
      repeatUntil: this.repeatUntil,
    });

    const data = {
      calendarId: this.calendarId,
      sendUpdates: this.sendUpdates,
      resource: {
        summary: this.summary,
        location: this.location,
        description: this.description,
        start: this.getDateParam({
          date: this.eventStartDate,
          timeZone,
        }),
        end: this.getDateParam({
          date: this.eventEndDate,
          timeZone,
        }),
        recurrence,
        attendees,
        colorId: this.colorId,
        visibility: this.visibility,
      },
    };

    if (this.createMeetRoom) {
      data.conferenceDataVersion = 1;
      data.resource.conferenceData = {
        createRequest: {
          requestId: uuidv4(),
          conferenceSolutionKey: {
            type: "hangoutsMeet",
          },
        },
      };
    }

    const response = await this.googleCalendar.createEvent(data);

    $.export("$summary", `Successfully created event with ID: "${response.id}"`);

    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
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
Type of Add	`addType`	`string`	Select a value from the drop down menu:`{ "label": "Add Detailed Event", "value": "detailed" }{ "label": "Add Quick Event using Natural Language", "value": "quick" }`
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.

Action 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.readonly

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

Other Popular Integrations#

List Calendar Events by Type with Google Calendar API on New Labeled Email from Gmail API

Gmail + Google Calendar

Create Event with Google Calendar API on New Labeled Email from Gmail API

Pipedream makes it easy to connect APIs for Google Calendar, Gmail and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular