Create Proxy Session with Oxylabs API on New Created or Updated Event (Instant) from Google Calendar API

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

Trigger workflow on

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

Next, do this

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

Select this integration
Configure the New Created or Updated Event (Instant) trigger
1. Connect your Google Calendar account
2. Optional- Select one or more Calendars
3. Optional- Configure Emit only for new events
4. Configure Push notification renewal schedule
Configure the Create Proxy Session action
1. Connect your Oxylabs account
2. Configure Username
3. Configure Password
4. Configure Session ID
5. Optional- Configure Country Code
6. Optional- Configure City
7. Optional- Configure State
8. Optional- Configure Session Time
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 Created or Updated Event (Instant) on Google Calendar

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

Version:0.1.15

Key:google_calendar-new-or-updated-event-instant

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 { v4 as uuid } from "uuid";
import sampleEmit from "./test-event.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "google_calendar-new-or-updated-event-instant",
  type: "source",
  name: "New Created or Updated Event (Instant)",
  description: "Emit new event when a Google Calendar events is created or updated (does not emit cancelled events)",
  version: "0.1.15",
  dedupe: "unique",
  props: {
    googleCalendar,
    db: "$.service.db",
    calendarIds: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
      type: "string[]",
      default: [
        "primary",
      ],
      label: "Calendars",
      description: "Select one or more calendars to watch (defaults to the primary calendar)",
    },
    newOnly: {
      label: "Emit only for new events",
      type: "boolean",
      description: "Emit new events only, and not updates to existing events (defaults to `false`)",
      optional: true,
      default: false,
    },
    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",
      static: {
        intervalSeconds: constants.WEBHOOK_SUBSCRIPTION_RENEWAL_SECONDS,
      },
    },
  },
  hooks: {
    async deploy() {
      const events = [];
      const params = {
        maxResults: 25,
        orderBy: "updated",
      };
      for (const calendarId of this.calendarIds) {
        params.calendarId = calendarId;
        const { items } = await this.googleCalendar.listEvents(params);
        events.push(...items);
      }
      events.sort((a, b) => (Date.parse(a.updated) > Date.parse(b.updated))
        ? 1
        : -1);
      for (const event of events.slice(-25)) {
        const meta = this.generateMeta(event);
        this.$emit(event, meta);
      }
    },
    async activate() {
      await this.makeWatchRequest();
    },
    async deactivate() {
      try {
        await this.stopWatchRequest();
      } catch (e) {
        console.log(`Error deactivating webhook. ${e}`);
      }
    },
  },
  methods: {
    setNextSyncToken(calendarId, nextSyncToken) {
      this.db.set(`${calendarId}.nextSyncToken`, nextSyncToken);
    },
    getNextSyncToken(calendarId) {
      return this.db.get(`${calendarId}.nextSyncToken`);
    },
    setChannelId(calendarId, channelId) {
      this.db.set(`${calendarId}.channelId`, channelId);
    },
    getChannelId(calendarId) {
      return this.db.get(`${calendarId}.channelId`);
    },
    setResourceId(calendarId, resourceId) {
      this.db.set(`${calendarId}.resourceId`, resourceId);
    },
    getResourceId(calendarId) {
      return this.db.get(`${calendarId}.resourceId`);
    },
    setExpiration(calendarId, expiration) {
      this.db.set(`${calendarId}.expiration`, expiration);
    },
    getExpiration(calendarId) {
      return this.db.get(`${calendarId}.expiration`);
    },
    /**
     * 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;
      const ts = Date.parse(tsString);
      return {
        id: `${id}-${ts}`,
        summary,
        ts,
      };
    },
    async makeWatchRequest() {
      // Make watch request for this HTTP endpoint
      for (const calendarId of this.calendarIds) {
        const watchResp =
          await this.googleCalendar.watchEvents({
            calendarId,
            requestBody: {
              id: uuid(),
              type: "web_hook",
              address: this.http.endpoint,
            },
          });

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

        this.setNextSyncToken(calendarId, nextSyncToken);
        this.setChannelId(calendarId, watchResp.id);
        this.setResourceId(calendarId, watchResp.resourceId);
        this.setExpiration(calendarId, watchResp.expiration);
      }
    },
    async stopWatchRequest() {
      for (const calendarId of this.calendarIds) {
        const id = this.getChannelId(calendarId);
        const resourceId = this.getResourceId(calendarId);
        if (id && resourceId) {
          const { status } =
            await this.googleCalendar.stopChannel({
              returnOnlyData: false,
              requestBody: {
                id,
                resourceId,
              },
            });
          if (status === 204) {
            console.log("webhook deactivated");
            this.setNextSyncToken(calendarId, null);
            this.setChannelId(calendarId, null);
            this.setResourceId(calendarId, null);
            this.setExpiration(calendarId, null);
          } else {
            console.log("There was a problem deactivating the webhook");
          }
        }
      }
    },
    getSoonestExpirationDate() {
      let min;
      for (const calendarId of this.calendarIds) {
        const expiration = parseInt(this.db.get(`${calendarId}.expiration`));
        if (!min || expiration < min) {
          min = expiration;
        }
      }
      return new Date(min);
    },
    getCalendarIdForChannelId(incomingChannelId) {
      for (const calendarId of this.calendarIds) {
        if (this.db.get(`${calendarId}.channelId`) === incomingChannelId) {
          return calendarId;
        }
      }
      return null;
    },
  },
  async run(event) {
    let calendarId = null; // calendar ID matching incoming channel ID

    // refresh watch
    if (event.interval_seconds) {
      // get time
      const now = new Date();
      const intervalMs = event.interval_seconds * 1000;
      // get expiration
      const expireDate = this.getSoonestExpirationDate();

      // if now + interval > expiration, refresh watch
      if (now.getTime() + intervalMs > expireDate.getTime()) {
        await this.stopWatchRequest();
        await this.makeWatchRequest();
      }
    } else {
      // Verify channel ID
      const incomingChannelId = event?.headers?.["x-goog-channel-id"];
      calendarId = this.getCalendarIdForChannelId(incomingChannelId);
      if (!calendarId) {
        console.log(
          `Unexpected channel ID ${incomingChannelId}. This likely means there are multiple, older subscriptions active.`,
        );
        return;
      }

      // Check that resource state === exists
      const state = event?.headers?.["x-goog-resource-state"];
      switch (state) {
      case "exists":
        // there's something to emit, so keep going
        break;
      case "not_exists":
        console.log("Resource does not exist. Exiting.");
        return;
      case "sync":
        console.log("New channel created");
        return;
      default:
        console.log(`Unknown state: ${state}`);
        return;
      }
    }

    // Fetch and emit events
    const checkCalendarIds = calendarId
      ? [
        calendarId,
      ]
      : this.calendarIds;
    for (const calendarId of checkCalendarIds) {
      const syncToken = this.getNextSyncToken(calendarId);
      let nextSyncToken = null;
      let nextPageToken = null;
      while (!nextSyncToken) {
        try {
          const { data: syncData = {} } = await this.googleCalendar.listEvents({
            returnOnlyData: false,
            calendarId,
            syncToken,
            pageToken: nextPageToken,
            maxResults: 2500,
          });

          nextPageToken = syncData.nextPageToken;
          nextSyncToken = syncData.nextSyncToken;

          const { items: events = [] } = syncData;
          events
            .filter(this.isEventRelevant, this)
            .forEach((event) => {
              const { status } = event;
              if (status === "cancelled") {
                console.log("Event cancelled. Exiting.");
                return;
              }
              const meta = this.generateMeta(event);
              this.$emit(event, meta);
            });
        } catch (error) {
          if (error === "Sync token is no longer valid, a full sync is required.") {
            console.log("Sync token invalid, resyncing");
            nextSyncToken = await this.googleCalendar.fullSync(calendarId);
            break;
          } else {
            throw error;
          }
        }
      }

      this.setNextSyncToken(calendarId, nextSyncToken);
    }
  },
  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.
Calendars	`calendarIds`	`string[]`	Select a value from the drop down menu.
Emit only for new events	`newOnly`	`boolean`	Emit new events only, and not updates to existing events (defaults to `false`)
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.
Push notification renewal schedule	`timer`	`$.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:

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#

Create Proxy Session on Oxylabs

Description:Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)

Version:0.0.1

Key:oxylabs-create-proxy-session

View on GitHub

Oxylabs Overview#

The Oxylabs API provides robust tools for web data extraction, enabling you to gather vast amounts of data efficiently from various sources across the web. With Pipedream's serverless platform, you can harness this power to create automated workflows that trigger on specific events, process the data, and connect to other services. Whether you're monitoring brand sentiment, tracking prices, or conducting market research, integrating Oxylabs with Pipedream can significantly streamline your data collection and analysis tasks.

Action Code#

import oxylabs from "../../oxylabs.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "oxylabs-create-proxy-session",
  name: "Create Proxy Session",
  description: "Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)",
  version: "0.0.1",
  type: "action",
  props: {
    oxylabs,
    username: {
      type: "string",
      label: "Username",
      description: "The username for the proxy user",
    },
    password: {
      type: "string",
      label: "Password",
      description: "The password for the proxy user",
    },
    sessid: {
      type: "string",
      label: "Session ID",
      description: "Session ID to keep the same IP with upcoming queries. The session expires in 10 minutes. After that, a new IP address is assigned to that session ID. Random string, 0-9, and A-Z characters are supported.",
    },
    cc: {
      type: "string",
      label: "Country Code",
      description: "Case insensitive country code in 2-letter [3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.",
      optional: true,
    },
    st: {
      type: "string",
      label: "State",
      description: "Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`",
      optional: true,
    },
    sstime: {
      type: "string",
      label: "Session Time",
      description: "Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      username,
      password,
      sessid,
      cc,
      city,
      st,
      sstime,
    } = this;

    if (city && !cc) {
      throw new ConfigurationError("City must be accompanied by country code");
    }

    const proxyUrl = `http://customer-${username}${cc
      ? `-cc-${cc}`
      : ""}${city
      ? `-city-${city}`
      : ""}${st
      ? `-st-${st}`
      : ""}${sessid
      ? `-sessid-${sessid}`
      : ""}${sstime
      ? `-sstime-${sstime}`
      : ""}:${password}@pr.oxylabs.io:7777`;
    const response = await this.oxylabs.createSession({
      $,
      proxyUrl,
    });
    $.export("$summary", `Successfully created proxy session with session ID: ${this.sessid}`);
    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
Oxylabs	`oxylabs`	`app`	This component uses the Oxylabs app.
Username	`username`	`string`	The username for the proxy user
Password	`password`	`string`	The password for the proxy user
Session ID	`sessid`	`string`	Session ID to keep the same IP with upcoming queries. The session expires in 10 minutes. After that, a new IP address is assigned to that session ID. Random string, 0-9, and A-Z characters are supported.
Country Code	`cc`	`string`	Case insensitive country code in 2-letter 3166-1 alpha-2 format
City	`city`	`string`	Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.
State	`st`	`string`	Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`
Session Time	`sstime`	`string`	Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.

Action Authentication#

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

Your API Username and Password are sent to your email when you sign up to Oxylabs.

About Oxylabs#

Market-leading proxy & web scraping solutions provider.

More Ways to Connect Oxylabs + Google Calendar#

Other Popular Integrations#

Create Proxy Session with Oxylabs API on New Cancelled Event from Google Calendar API

Google Calendar + Oxylabs

Create Proxy Session with Oxylabs API on New Created or Updated Event (Instant) from Google Calendar API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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