Create Customer with Help Scout API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for Help Scout, Google Drive and 2,700+ other apps remarkably fast.

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

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

Select this integration
Configure the Changes to Specific Files trigger
1. Connect your Google Drive account
2. Optional- Configure Drive
3. Configure Push notification renewal schedule
4. Select one or more Files
5. Configure intervalAlert
6. Optional- Configure Minimum Interval Per File
7. Select one or more Types of updates
Configure the Create Customer action
1. Connect your Help Scout account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Phone
5. Optional- Configure Photo URL
6. Optional- Configure Job Title
7. Optional- Select a Photo Type
8. Optional- Configure Background
9. Optional- Configure Location
10. Optional- Configure Organization
11. Optional- Select a Gender
12. Optional- Configure Age
13. Optional- Configure Emails
14. Optional- Configure Phones
15. Optional- Configure Chats
16. Optional- Configure Social Profiles
17. Optional- Configure Websites
18. Optional- Configure Address City
19. Optional- Configure Address State
20. Optional- Configure Address Postal Code
21. Optional- Configure Address Country
22. Optional- Configure Address Lines
23. Optional- Configure Properties
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#

Changes to Specific Files on Google Drive

Description:Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.

Version:0.2.6

Key:google_drive-changes-to-specific-files

View on GitHub

Google Drive Overview#

The Google Drive API on Pipedream allows you to automate various file management tasks, such as creating, reading, updating, and deleting files within your Google Drive. You can also share files, manage permissions, and monitor changes to files and folders. This opens up possibilities for creating workflows that seamlessly integrate with other apps and services, streamlining document handling, backup processes, and collaborative workflows.

Trigger Code#

import cronParser from "cron-parser";
import sampleEmit from "./test-event.mjs";
import includes from "lodash/includes.js";
import { v4 as uuid } from "uuid";
import { MY_DRIVE_VALUE } from "../../common/constants.mjs";
import changesToSpecificFiles from "../changes-to-specific-files-shared-drive/changes-to-specific-files-shared-drive.mjs";

/**
 * This source uses the Google Drive API's
 * {@link https://developers.google.com/drive/api/v3/reference/files/watch files: watch}
 * endpoint to subscribe to changes to specific files in the user's drive.
 */
export default {
  ...changesToSpecificFiles,
  key: "google_drive-changes-to-specific-files",
  name: "Changes to Specific Files",
  description: "Watches for changes to specific files, emitting an event when a change is made to one of those files. To watch for changes to [shared drive](https://support.google.com/a/users/answer/9310351) files, use the **Changes to Specific Files (Shared Drive)** source instead.",
  version: "0.2.6",
  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: {
    ...changesToSpecificFiles.props,
    drive: {
      type: "string",
      label: "Drive",
      description: "Defaults to `My Drive`. To use a [Shared Drive](https://support.google.com/a/users/answer/9310351), use the **Changes to Specific Files (Shared Drive)** source instead.",
      optional: true,
      default: MY_DRIVE_VALUE,
    },
    updateTypes: {
      propDefinition: [
        changesToSpecificFiles.props.googleDrive,
        "updateTypes",
      ],
    },
  },
  hooks: {
    ...changesToSpecificFiles.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 = 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._getSubscriptions() || {};

      const files = this.files;
      for (const fileID of files) {
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.activateFileHook(
          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._setSubscriptions(subscriptions);
      this._setChannelID(channelID);
    },
    async deactivate() {
      const channelID = this._getChannelID();
      if (!channelID) {
        console.log(
          "Channel not found, cannot stop notifications for non-existent channel",
        );
        return;
      }

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

      // Reset DB state
      this._setSubscriptions({});
      this._setChannelID(null);
    },
  },
  methods: {
    ...changesToSpecificFiles.methods,
    _getSubscriptions() {
      return this.db.get("subscriptions") || {};
    },
    _setSubscriptions(subscriptions) {
      this.db.set("subscriptions", subscriptions);
    },
    _getNextTimerEventTimestamp(event) {
      if (event.cron) {
        return cronParser
          .parseExpression(event.cron)
          .next()
          .getTime();
      }
      if (event.interval_seconds) {
        return Date.now() + event.interval_seconds * 1000;
      }
    },
    async renewFileSubscriptions(event) {
      const subscriptions = this._getSubscriptions() || {};
      const channelID = this._getChannelID();
      const newChannelID = uuid();

      const nextRunTimestamp = this._getNextTimerEventTimestamp(event);

      for (const [
        currentResourceId,
        metadata,
      ] of Object.entries(subscriptions)) {
        const { fileID } = metadata;

        const subscription = {
          ...metadata,
          resourceId: currentResourceId,
        };
        const {
          expiration,
          resourceId,
        } = await this.googleDrive.renewFileSubscription(
          subscription,
          this.http.endpoint,
          channelID,
          newChannelID,
          fileID,
          nextRunTimestamp,
        );
        subscriptions[resourceId] = {
          expiration,
          fileID,
        };
      }
      this._setSubscriptions(subscriptions);
      this._setChannelID(newChannelID);
    },
  },
  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)

    // Component was invoked by timer
    if (event.timestamp) {
      return this.renewFileSubscriptions(event);
    }

    const channelID = this._getChannelID();
    let subscriptions = this._getSubscriptions() || {};

    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 [
      checkedFile,
    ] = this.checkMinimumInterval([
      file,
    ]);
    if (checkedFile) {
      this.processChange(file, headers);
    }
  },
  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 Drive	`googleDrive`	`app`	This component uses the Google Drive app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Drive	`drive`	`string`	Defaults to `My Drive`. To use a Shared Drive, use the Changes to Specific Files (Shared Drive) source instead.
Files	`files`	`string[]`	Select a value from the drop down menu.
Minimum Interval Per File	`perFileInterval`	`integer`	How many minutes to wait until the same file can emit another event. If set to `0`, this interval is disabled and all events will be emitted.
Types of updates	`updateTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "'sync' - A channel was successfully created. You can expect to start receiving notifications for it.", "value": "sync" }{ "label": "'add' - A resource was created or shared.", "value": "add" }{ "label": "'remove' - An existing resource was deleted or unshared.", "value": "remove" }{ "label": "'update' - One or more properties (metadata) of a resource have been updated.", "value": "update" }{ "label": "'trash' - A resource has been moved to the trash.", "value": "trash" }{ "label": "'untrash' - A resource has been removed from the trash.", "value": "untrash" }{ "label": "'change' - One or more changelog items have been added.", "value": "change" }`

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:

https://www.googleapis.com/auth/drive

About Google Drive#

Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.

Action#

Create Customer on Help Scout

Description:Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)

Version:0.0.1

Key:help_scout-create-customer

View on GitHub

Help Scout Overview#

The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  GENDER_OPTIONS,
  PHOTO_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import {
  cleanObject,
  parseObject,
} from "../../common/utils.mjs";
import helpScout from "../../help_scout.app.mjs";

export default {
  key: "help_scout-create-customer",
  name: "Create Customer",
  description: "Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)",
  version: "0.0.1",
  type: "action",
  props: {
    helpScout,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the customer. When defined it must be between 1 and 40 characters.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the customer. When defined it must be between 1 and 40 characters.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone number that will be used when creating a new customer.",
      optional: true,
    },
    photoUrl: {
      type: "string",
      label: "Photo URL",
      description: "URL of the customer's photo. Max length 200 characters.",
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "Job title. Max length 60 characters.",
      optional: true,
    },
    photoType: {
      type: "string",
      label: "Photo Type",
      description: "The type of photo.",
      options: PHOTO_TYPE_OPTIONS,
      optional: true,
    },
    background: {
      type: "string",
      label: "Background",
      description: "This is the Notes field from the user interface. Max length 200 characters.",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "Location of the customer. Max length 60 characters.",
      optional: true,
    },
    organization: {
      type: "string",
      label: "Organization",
      description: "Organization. Max length 60 characters.",
      optional: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Gender of this customer.",
      options: GENDER_OPTIONS,
      optional: true,
    },
    age: {
      type: "string",
      label: "Age",
      description: "Customer's age.",
      optional: true,
    },
    emails: {
      type: "string[]",
      label: "Emails",
      description: "List of email entries. **Format: {\"type\":\"home\",\"value\":\"customer@email.com\"}**. see [Create Email](https://developer.helpscout.com/mailbox-api/endpoints/customers/emails/create) for the object documentation.",
      optional: true,
    },
    phones: {
      type: "string[]",
      label: "Phones",
      description: "List of phone entries. **Format: {\"type\":\"work\",\"value\":\"222-333-4444\"}**. see [Create Phone](https://developer.helpscout.com/mailbox-api/endpoints/customers/phones/create) for the object documentation.",
      optional: true,
    },
    chats: {
      type: "string[]",
      label: "Chats",
      description: "List of chat entries. **Format: {\"type\":\"aim\",\"value\":\"jsprout\"}**. see [Create Chat Handle](https://developer.helpscout.com/mailbox-api/endpoints/customers/chat_handles/create) for the object documentation.",
      optional: true,
    },
    socialProfiles: {
      type: "string[]",
      label: "Social Profiles",
      description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.",
      optional: true,
    },
    websites: {
      type: "string[]",
      label: "Websites",
      description: "List of websites entries. **Format: {\"value\":\"https://api.helpscout.net/\"}**. see [Create Website](https://developer.helpscout.com/mailbox-api/endpoints/customers/websites/create) for the object documentation.",
      optional: true,
    },
    addressCity: {
      type: "string",
      label: "Address City",
      description: "The city of the customer.",
      optional: true,
    },
    addressState: {
      type: "string",
      label: "Address State",
      description: "The state of the customer.",
      optional: true,
    },
    addressPostalCode: {
      type: "string",
      label: "Address Postal Code",
      description: "The postal code of the customer.",
      optional: true,
    },
    addressCountry: {
      type: "string",
      label: "Address Country",
      description: "The [ISO 3166 Alpha-2 code](https://www.iban.com/country-codes) country of the customer.",
      optional: true,
    },
    addressLines: {
      type: "string[]",
      label: "Address Lines",
      description: "A list of address lines.",
      optional: true,
    },
    properties: {
      type: "string[]",
      label: "Properties",
      description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.",
      optional: true,
    },
  },
  async run({ $ }) {
    const address = cleanObject({
      city: this.addressCity,
      state: this.addressState,
      postalCode: this.addressPostalCode,
      country: this.addressCountry,
      lines: parseObject(this.addressLines),
      properties: parseObject(this.properties),
    });

    let data = {};

    data = cleanObject({
      firstName: this.firstName,
      lastName: this.lastName,
      phone: this.phone,
      photoUrl: this.photoUrl,
      jobTitle: this.jobTitle,
      photoType: this.photoType,
      background: this.background,
      location: this.location,
      organization: this.organization,
      gender: this.gender,
      age: this.age,
      emails: parseObject(this.emails),
      phones: parseObject(this.phones),
      chats: parseObject(this.chats),
      socialProfiles: parseObject(this.socialProfiles),
      websites: parseObject(this.websites),
    });

    if (Object.keys(address).length) data.address = address;

    if (!Object.keys(data).length) {
      throw new ConfigurationError("At least one field or customer entry must be defined.");
    }

    try {
      const response = await this.helpScout.createCustomer({
        $,
        data,
      });

      $.export("$summary", "Successfully created the new customer.");
      return response;
    } catch ({ message }) {
      const error = JSON.parse(message)._embedded.errors[0];
      throw new ConfigurationError(`Path: ${error.path} - ${error.message}`);
    }
  },
};

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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
First Name	`firstName`	`string`	First name of the customer. When defined it must be between 1 and 40 characters.
Last Name	`lastName`	`string`	Last name of the customer. When defined it must be between 1 and 40 characters.
Phone	`phone`	`string`	The phone number that will be used when creating a new customer.
Photo URL	`photoUrl`	`string`	URL of the customer's photo. Max length 200 characters.
Job Title	`jobTitle`	`string`	Job title. Max length 60 characters.
Photo Type	`photoType`	`string`	Select a value from the drop down menu:`unknowngravatartwitterfacebookgoogleprofilegooglepluslinkedininstagram`
Background	`background`	`string`	This is the Notes field from the user interface. Max length 200 characters.
Location	`location`	`string`	Location of the customer. Max length 60 characters.
Organization	`organization`	`string`	Organization. Max length 60 characters.
Gender	`gender`	`string`	Select a value from the drop down menu:`malefemaleunknown`
Age	`age`	`string`	Customer's age.
Emails	`emails`	`string[]`	List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation.
Phones	`phones`	`string[]`	List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation.
Chats	`chats`	`string[]`	List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation.
Social Profiles	`socialProfiles`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.
Websites	`websites`	`string[]`	List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation.
Address City	`addressCity`	`string`	The city of the customer.
Address State	`addressState`	`string`	The state of the customer.
Address Postal Code	`addressPostalCode`	`string`	The postal code of the customer.
Address Country	`addressCountry`	`string`	The ISO 3166 Alpha-2 code country of the customer.
Address Lines	`addressLines`	`string[]`	A list of address lines.
Properties	`properties`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.

Action Authentication#

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

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

About Help Scout#

Simple Customer Service Software and Education

More Ways to Connect Help Scout + Google Drive#

Other Popular Integrations#

Create Customer with Help Scout API on New Presentation (Instant) from Google Drive API

Google Drive + Help Scout

Create Customer with Help Scout API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for Help Scout, Google Drive 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