← Google Calendar + Slack integrations

Send Message to a Private Channel with Slack APIon New or Updated Event (Instant) from Google Calendar API

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

Trigger workflow on
New or Updated Event (Instant) from the Google Calendar API
Next, do this
Send Message to a Private Channel with the Slack API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a Google Calendar trigger and Slack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New or Updated Event (Instant) trigger
    1. Connect your Google Calendar account
    2. Select a Calendar
    3. Configure New events only?
    4. Configure Push notification renewal schedule
  3. Configure the Send Message to a Private Channel action
    1. Connect your Slack account
    2. Select a Channel
    3. Configure Text
    4. Optional- Configure Send as User
    5. Optional- Configure Bot Username
    6. Optional- Configure Icon (emoji)
    7. Optional- Configure Icon (image URL)
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emits when an event is created or updated (except when it's cancelled)
Version:0.0.4
Key:google_calendar-new-or-updated-event-instant

Trigger Code

const get = require("lodash/get");
const { v4: uuid } = require("uuid");

const googleCalendar = require("../../google_calendar.app.js");

module.exports = {
  key: "google_calendar-new-or-updated-event-instant",
  name: "New or Updated Event (Instant)",
  description:
    "Emits when an event is created or updated (except when it's cancelled)",
  version: "0.0.4",
  props: {
    googleCalendar,
    db: "$.service.db",
    calendarId: {
      type: "string",
      label: "Calendar",
      async options() {
        const calListResp = await this.googleCalendar.calendarList();
        const calendars = get(calListResp, "data.items");
        if (calendars) {
          const calendarIds = calendars.map((item) => ({
            value: item.id,
            label: item.summary,
          }));
          return calendarIds;
        }
        return [];
      },
    },
    newOnly: {
      label: "New events only?",
      type: "boolean",
      description: "Emit new events only, and not updates to existing events",
    },
    http: "$.interface.http",
    timer: {
      label: "Push notification renewal schedule",
      description:
        "The Google Calendar API requires occasional renewal of push notification subscriptions. **This runs in the background, so you should not need to modify this schedule**.",
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
  },
  hooks: {
    async activate() {
      // make watch request that will hit this http interface
      const config = {
        calendarId: this.calendarId,
        requestBody: {
          id: uuid(),
          type: "web_hook",
          address: this.http.endpoint,
        },
      };
      const watchResp = await this.googleCalendar.watch(config);
      const data = watchResp.data;

      // initial full sync get next sync token
      const nextSyncToken = await this.googleCalendar.fullSync(this.calendarId);

      this.db.set("nextSyncToken", nextSyncToken);
      this.db.set("channelId", data.id);
      this.db.set("resourceId", data.resourceId);
      this.db.set("expiration", data.expiration);
    },
    async deactivate() {
      const id = this.db.get("channelId");
      const resourceId = this.db.get("resourceId");
      if (id && resourceId) {
        const config = {
          requestBody: {
            id,
            resourceId,
          },
        };
        const stopResp = await this.googleCalendar.stop(config);
        if (stopResp.status === 204) {
          console.log("webhook deactivated");
          this.db.set("nextSyncToken", null);
          this.db.set("channelId", null);
          this.db.set("resourceId", null);
          this.db.set("expiration", null);
        } else {
          console.log("there was a problem deactivating the webhook");
        }
      }
    },
  },
  methods: {
    /**
     * A utility method to compute whether the provided event is newly created
     * or not. Since the Google Calendar API does not provide a specific way to
     * determine this, this method estimates the result based on the `created`
     * and `updated` timestamps: if they are more than 2 seconds apart, then we
     * assume that the event is not new.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event is a newly created event, or
     * false otherwise
     */
    _isNewEvent(event) {
      const {
        created,
        updated,
      } = event;
      const createdTimestampMilliseconds = Date.parse(created);
      const updatedTimestampMilliseconds = Date.parse(updated);
      const diffMilliseconds = Math.abs(
        updatedTimestampMilliseconds - createdTimestampMilliseconds,
      );
      const maxDiffMilliseconds = 2000;
      return diffMilliseconds <= maxDiffMilliseconds;
    },
    /**
     * A utility method to compute whether the provided event is relevant to the
     * event source (and as a consequence must be processed) or not.
     *
     * @param {Object} event - The calendar event being processed
     * @returns {Boolean} True if the input event must be processed, or false
     * otherwise (i.e. if the event must be skipped)
     */
    isEventRelevant(event) {
      return !this.newOnly || this._isNewEvent(event);
    },
    generateMeta(event) {
      const {
        id,
        summary,
        updated: tsString,
      } = event;
      return {
        id,
        summary,
        ts: Date.parse(tsString),
      };
    },
  },
  async run(event) {
    // refresh watch
    if (event.interval_seconds) {
      // get time
      const now = new Date();
      const intervalMs = event.interval_seconds * 1000;
      // get expiration
      const expiration = this.db.get("expiration");
      const expireDate = new Date(parseInt(expiration));

      // if now + interval > expiration, refresh watch
      if (now.getTime() + intervalMs > expireDate.getTime()) {
        // do the webhook refresh
        const config = {
          calendarId: this.calendarId,
          requestBody: {
            id: uuid(),
            type: "web_hook",
            address: this.http.endpoint,
          },
        };
        const watchResp = await this.googleCalendar.watch(config);
        const data = watchResp.data;
        // full sync get next sync token
        const nextSyncToken = await this.googleCalendar.fullSync(
          this.calendarId,
        );

        // stop the previous watch
        const id = this.db.get("channelId");
        const resourceId = this.db.get("resourceId");
        if (id && resourceId) {
          const config = {
            requestBody: {
              id,
              resourceId,
            },
          };
          const stopResp = await this.googleCalendar.stop(config);
          if (stopResp.status === 204) {
            console.log("webhook deactivated");
          } else {
            console.log("there was a problem deactivating the webhook");
          }
        }

        this.db.set("nextSyncToken", nextSyncToken);
        this.db.set("channelId", data.id);
        this.db.set("resourceId", data.resourceId);
        this.db.set("expiration", data.expiration);
      }
    } else {
      // verify channel id
      const expectedChannelId = this.db.get("channelId");
      const channelId = get(event, "headers.x-goog-channel-id");
      if (expectedChannelId != channelId) {
        console.log(
          `expected ${expectedChannelId} but got ${channelId}.  Most likely there are multiple webhooks active.`,
        );
        return;
      }
      // check that resource state is exists
      const state = get(event, "headers.x-goog-resource-state");
      switch (state) {
      case "exists":
        // there's something to emit
        break;
      case "not_exists":
        // TODO handle this?
        return;
      case "sync":
        console.log("new channel created");
        return;
      }
      // do a listing and then emit everything?
      const syncToken = this.db.get("nextSyncToken");
      let nextSyncToken = null;
      let nextPageToken = null;
      while (!nextSyncToken) {
        const listConfig = {
          calendarId: this.calendarId,
          syncToken,
        };
        listConfig.pageToken = nextPageToken;
        const {
          data: syncData = {},
          status: syncStatus,
        } = await this.googleCalendar.list(listConfig);
        if (syncStatus == 410) {
          nextSyncToken = await this.googleCalendar.fullSync(this.calendarId);
          console.log("sync token is gone, resyncing");
          break;
        }
        nextPageToken = syncData.nextPageToken;
        nextSyncToken = syncData.nextSyncToken;

        // loop and emit
        const { items: events = [] } = syncData;
        events
          .filter(this.isEventRelevant, this)
          .forEach((event) => {
            const meta = this.generateMeta(event);
            this.$emit(event, meta);
          });
      }

      this.db.set("nextSyncToken", nextSyncToken);
    }
  },
};

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.
LabelPropTypeDescription
Google CalendargoogleCalendarappThis component uses the Google Calendar app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
CalendarcalendarIdstringSelect a value from the drop down menu.
New events only?newOnlyboolean

Emit new events only, and not updates to existing events

N/Ahttp$.interface.httpThis 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.
Push notification renewal scheduletimer$.interface.timer

The Google Calendar API requires occasional renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.

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:

emailprofilehttps://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonly

About Google Calendar

Scheduling calendar service developed by Google

Action

Description:Send a message to a private channel and customize the name and avatar of the bot that posts the message
Version:0.1.0
Key:slack-send-message-private-channel

Action Code

const slack = require("../../slack.app.js");

module.exports = {
  key: "slack-send-message-private-channel",
  name: "Send Message to a Private Channel",
  description: "Send a message to a private channel and customize the name and avatar of the bot that posts the message",
  version: "0.1.0",
  type: "action",
  props: {
    slack,
    conversation: {
      propDefinition: [
        slack,
        "privateChannel",
      ],
    },
    text: {
      propDefinition: [
        slack,
        "text",
      ],
    },
    as_user: {
      propDefinition: [
        slack,
        "as_user",
      ],
    },
    username: {
      propDefinition: [
        slack,
        "username",
      ],
      description: "Optionally customize your bot's username (default is `Pipedream`).",
    },
    icon_emoji: {
      propDefinition: [
        slack,
        "icon_emoji",
      ],
      description: "Optionally use an emoji as the bot icon for this message (e.g., `:fire:`). This value overrides `icon_url` if both are provided.",
    },
    icon_url: {
      propDefinition: [
        slack,
        "icon_url",
      ],
      description: "Optionally provide an image URL to use as the bot icon for this message.",
    },
  },
  async run() {
    return await this.slack.sdk().chat.postMessage({
      channel: this.conversation,
      text: this.text,
      as_user: this.as_user,
      username: this.username,
      icon_emoji: this.icon_emoji,
      icon_url: this.icon_url,
    });
  },
};

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.

LabelPropTypeDescription
SlackslackappThis component uses the Slack app.
ChannelconversationstringSelect a value from the drop down menu.
Texttextstring

Text of the message to send (see Slack's formatting docs). This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.

Send as Useras_userboolean

Optionally pass TRUE to post the message as the authed user, instead of as a bot. Defaults to FALSE.

Bot Usernameusernamestring

Optionally customize your bot's username (default is Pipedream).

Icon (emoji)icon_emojistring

Optionally use an emoji as the bot icon for this message (e.g., :fire:). This value overrides icon_url if both are provided.

Icon (image URL)icon_urlstring

Optionally provide an image URL to use as the bot icon for this message.

Action Authentication

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

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

calls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:read

About Slack

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

More Ways to Connect Slack + Google Calendar

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.