← Google Drive + Ongage integrations

Ongage Find Subscriber with Ongage APIon Changes to Specific Files from Google Drive API

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

Trigger workflow on
Changes to Specific Files from the Google Drive API
Next, do this
Ongage Find Subscriber with the Ongage 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 Drive trigger and Ongage 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 Changes to Specific Files trigger
    1. Connect your Google Drive account
    2. Select a Drive
    3. Optional- Configure Watch for changes to file properties
    4. Configure Push notification renewal schedule
    5. Optional- Select one or more Files
    6. Select one or more Types of updates
  3. Configure the Ongage Find Subscriber action
    1. Connect your Ongage account
    2. Configure Email Address
    3. Configure Halt on error?
  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:Watches for changes to specific files, emitting an event any time a change is made to one of those files
Version:0.0.12
Key:google_drive-changes-to-specific-files

Trigger Code

// This source processes changes to specific files in a user's Google Drive,
// implementing strategy enumerated in the Push Notifications API docs:
// https://developers.google.com/drive/api/v3/push .
//
// This source has two interfaces:
//
// 1) The HTTP requests tied to changes in the user's Google Drive
// 2) A timer that runs on regular intervals, renewing the notification channel as needed

const cronParser = require("cron-parser");
const includes = require("lodash/includes");
const { v4: uuid } = require("uuid");

const googleDrive = require("../../google_drive.app.js");
const common = require("../common-webhook.js");

module.exports = {
  ...common,
  key: "google_drive-changes-to-specific-files",
  name: "Changes to Specific Files",
  description:
    "Watches for changes to specific files, emitting an event any time a change is made to one of those files",
  version: "0.0.12",
  type: "source",
  // Dedupe events based on the "x-goog-message-number" header for the target channel:
  // https://developers.google.com/drive/api/v3/push#making-watch-requests
  dedupe: "unique",
  props: {
    ...common.props,
    files: {
      type: "string[]",
      label: "Files",
      description: "The files you want to watch for changes.",
      optional: true,
      default: [],
      options({ prevContext }) {
        const { nextPageToken } = prevContext;
        const baseOpts = {};
        const opts = this.isMyDrive()
          ? baseOpts
          : {
            ...baseOpts,
            corpora: "drive",
            driveId: this.getDriveId(),
            includeItemsFromAllDrives: true,
            supportsAllDrives: true,
          };
        return this.googleDrive.listFilesOptions(nextPageToken, opts);
      },
    },
    updateTypes: {
      propDefinition: [
        googleDrive,
        "updateTypes",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      // Called when a component is created or updated. Handles all the logic
      // for starting and stopping watch notifications tied to the desired
      // files.

      // You can pass the same channel ID in watch requests for multiple files, so
      // our channel ID is fixed for this component to simplify the state we have to
      // keep track of.
      const channelID = this.db.get("channelID") || uuid();

      // Subscriptions are keyed on Google's resourceID, "an opaque value that
      // identifies the watched resource". This value is included in request
      // headers, allowing us to look up the watched resource.
      let subscriptions = this.db.get("subscriptions") || {};

      for (const fileID of this.files) {
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.watchFile(
          channelID,
          this.http.endpoint,
          fileID,
        );
        // The fileID must be kept with the subscription metadata so we can
        // renew the watch request for this specific file when it expires.
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }

      // Save metadata on the subscription so we can stop / renew later
      this.db.set("subscriptions", subscriptions);
      this.db.set("channelID", channelID);
    },
    async deactivate() {
      const channelID = this.db.get("channelID");
      if (!channelID) {
        console.log(
          "Channel not found, cannot stop notifications for non-existent channel",
        );
        return;
      }

      const subscriptions = this.db.get("subscriptions") || {};
      for (const resourceId of Object.keys(subscriptions)) {
        await this.googleDrive.stopNotifications(channelID, resourceId);
      }

      // Reset DB state
      this.db.set("subscriptions", {});
      this.db.set("channelID", null);
    },
  },
  methods: {
    ...common.methods,
    _getNextTimerEventTimestamp(event) {
      if (event.cron) {
        return cronParser
          .parseExpression(event.cron)
          .next()
          .getTime();
      }
      if (event.interval_seconds) {
        return Date.now() + event.interval_seconds * 1000;
      }
    },
    getUpdateTypes() {
      return this.updateTypes;
    },
  },
  async run(event) {
    // This function is polymorphic: it can be triggered as a cron job, to make sure we renew
    // watch requests for specific files, or via HTTP request (the change payloads from Google)

    let subscriptions = this.db.get("subscriptions") || {};
    const channelID = this.db.get("channelID");

    // Component was invoked by timer
    if (event.timestamp) {
      for (const [
        currentResourceId,
        metadata,
      ] of Object.entries(subscriptions)) {
        const { fileID } = metadata;
        // If the subscription for this resource will expire before the next run,
        // stop the existing subscription and renew
        if (metadata.expiration < this._getNextTimerEventTimestamp(event)) {
          console.log(
            `Notifications for resource ${currentResourceId} are expiring at ${metadata.expiration}. Renewing`,
          );
          await this.googleDrive.stopNotifications(
            channelID,
            currentResourceId,
          );
          const {
            expiration,
            resourceId,
          } = await this.googleDrive.watchFile(
            channelID,
            this.http.endpoint,
            fileID,
          );
          subscriptions[resourceId] = {
            expiration,
            fileID,
          };
        }
      }

      this.db.set("subscriptions", subscriptions);
      return;
    }

    const { headers } = event;

    if (
      !headers["x-goog-resource-state"] ||
      !headers["x-goog-resource-id"] ||
      !headers["x-goog-resource-uri"] ||
      !headers["x-goog-message-number"]
    ) {
      console.log("Request missing necessary headers: ", headers);
      return;
    }

    const incomingChannelID = headers["x-goog-channel-id"];
    if (incomingChannelID !== channelID) {
      console.log(
        `Channel ID of ${incomingChannelID} not equal to deployed component channel of ${channelID}`,
      );
      return;
    }

    if (subscriptions[headers["x-goog-resource-id"]] === undefined) {
      console.log(
        `Resource ID of ${headers["x-goog-resource-id"]} not currently being tracked. Exiting`,
      );
      return;
    }

    if (!includes(this.updateTypes, headers["x-goog-resource-state"])) {
      console.log(
        `Update type ${headers["x-goog-resource-state"]} not in list of updates to watch: `,
        this.updateTypes,
      );
      return;
    }

    // We observed false positives where a single change to a document would trigger two changes:
    // one to "properties" and another to "content,properties". But changes to properties
    // alone are legitimate, most users just won't want this source to emit in those cases.
    // If x-goog-changed is _only_ set to "properties", only move on if the user set the prop
    if (
      !this.watchForPropertiesChanges &&
      headers["x-goog-changed"] === "properties"
    ) {
      console.log(
        "Change to properties only, which this component is set to ignore. Exiting",
      );
      return;
    }

    const file = await this.googleDrive.getFileMetadata(
      headers["x-goog-resource-uri"],
    );

    if (!file || !Object.keys(file).length) {
      console.log("No file metadata returned, nothing to emit");
      return;
    }

    const eventToEmit = {
      file,
      change: {
        state: headers["x-goog-resource-state"],
        resourceURI: headers["x-goog-resource-uri"],
        changed: headers["x-goog-changed"], // "Additional details about the changes. Possible values: content, parents, children, permissions"
      },
    };

    this.$emit(eventToEmit, {
      summary: `${headers["x-goog-resource-state"].toUpperCase()} - ${
        file.name || "Untitled"
      }`,
      id: headers["x-goog-message-number"],
    });
  },
};

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 DrivegoogleDriveappThis component uses the Google Drive app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
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.
DrivedrivestringSelect a value from the drop down menu.
Watch for changes to file propertieswatchForPropertiesChangesboolean

Watch for changes to file properties
in addition to changes to content. Defaults to false, watching for only changes to content.

Push notification renewal scheduletimer$.interface.timer

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

Filesfilesstring[]Select a value from the drop down menu.
Types of updatesupdateTypesstring[]Select a value from the drop down menu:syncaddremoveupdatetrashuntrashchange

Trigger Authentication

Google Drive uses OAuth authentication. When you connect your Google Drive account, Pipedream will open a popup window where you can sign into Google Drive 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 Drive API.

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

emailprofilehttps://www.googleapis.com/auth/drivehttps://www.googleapis.com/auth/drive.readonly

About Google Drive

Internet-related services and products

Action

Description:Find a list subscriber in Ongage.
Version:0.0.1
Key:ongage-find-subscriber

Action Code

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

module.exports = {
  key: "ongage-find-subscriber",
  name: "Ongage Find Subscriber",
  description: "Find a list subscriber in Ongage.",
  version: "0.0.1",
  type: "action",
  props: {
    ongage,
    email: {
      propDefinition: [
        ongage,
        "email",
      ],
    },
    haltOnError: {
      propDefinition: [
        ongage,
        "haltOnError",
      ],
    },
  },
  async run () {
    try {
      return await this.ongage.findSubscriber(
        this.email,
      );
    } catch (err) {
      if (this.haltOnError) {
        throw err;
      }
      if (err.response) {
        return err.response.data;
      }
      return err;
    }
  },
};

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
OngageongageappThis component uses the Ongage app.
Email Addressemailstring
Halt on error?haltOnErrorboolean

Action Authentication

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

Connect to your Ongage account using the Username and Password of the Ongage User who will be using and issuing the API commands, along with your Account Code, that you can find under the Account Profile. See docs.

x_username: your_ongage_username
x_password: your_ongage_password
x_account_code: your_ongage_account_code

About Ongage

Email Marketing Platform For Data-Driven Growth

More Ways to Connect Ongage + Google Drive

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.

Explore Other Apps

1
-
12
of
500+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Discord Webhook
Discord Webhook
Use this app to send messages to a channel using Discord's incoming webhooks
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Slack
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.
Airtable
Airtable
Looks like a spreadsheet, acts like a database.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
Google Drive
Google Drive
Internet-related services and products
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Twilio
Twilio
Cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale
Twitter
Twitter
From breaking news and entertainment to sports and politics, get the full story with all the live commentary.
Zoom
Zoom
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.
Zoom Admin
Zoom Admin
Video conferencing (includes account-level scopes)