Update Campaign with Mailchimp API on Changes to Specific Files from Google Drive API

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

Trigger workflow on

Changes to Specific Files from the Google Drive API

Next, do this

Update Campaign with the Mailchimp 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 Mailchimp 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 Update Campaign action
1. Connect your Mailchimp account
2. Select a Campaign ID
3. Select a List Id
4. Optional- Select a Saved segment ID
5. Optional- Configure Prebuilt segment ID
6. Optional- Select a Segment match
7. Optional- Configure Segment condition
8. Optional- Configure Subject line
9. Optional- Configure Preview text
10. Optional- Configure Title
11. Optional- Configure From name
12. Optional- Configure Reply to
13. Optional- Configure Use conversations
14. Optional- Configure To name
15. Optional- Configure Folder ID
16. Optional- Configure Authenticate
17. Optional- Configure Auto footer
18. Optional- Configure Inline css
19. Optional- Configure Auto tweet
20. Optional- Configure Auto facebook post
21. Optional- Configure Facebook comment
22. Optional- Configure Template ID
23. Optional- Configure Opens
24. Optional- Configure HTML clicks
25. Optional- Configure Text clicks
26. Optional- Configure Goal tracking
27. Optional- Configure E-commerce tracking
28. Optional- Configure Google analytics
29. Optional- Configure Clicktale
30. Optional- Configure Salesforce campaign
31. Optional- Configure Salesforce notes
32. Optional- Configure Capsule notes
33. Optional- Configure Social image url
34. Optional- Configure Social description
35. Optional- Select a Social title
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#

Update Campaign on Mailchimp

Description:Update a campaign. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/update-campaign-settings/)

Version:0.0.1

Key:mailchimp-update-campaign

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Action Code#

import mailchimp from "../../mailchimp.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "mailchimp-update-campaign",
  name: "Update Campaign",
  description: "Update a campaign. [See docs here](https://mailchimp.com/developer/marketing/api/campaigns/update-campaign-settings/)",
  version: "0.0.1",
  type: "action",
  props: {
    mailchimp,
    campaignId: {
      propDefinition: [
        mailchimp,
        "campaignId",
      ],
    },
    listId: {
      propDefinition: [
        mailchimp,
        "listId",
      ],
      label: "List Id",
      description: "The unique ID of the list",
    },
    savedSegmentId: {
      propDefinition: [
        mailchimp,
        "segmentId",
        (c) => ({
          listId: c.listId,
        }),
      ],
      label: "Saved segment ID",
      description: "The ID for an existing saved segment.",
      optional: true,
    },
    prebuiltSegmentId: {
      type: "string",
      label: "Prebuilt segment ID",
      description: "The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.",
      optional: true,
    },
    segmentMatch: {
      type: "string",
      label: "Segment match",
      description: "Segment match type.",
      optional: true,
      options: constants.SEGMENT_MATCHES,
    },
    segmentConditions: {
      type: "any",
      label: "Segment condition",
      description: "Segment match conditions.",
      optional: true,
    },
    subjectLine: {
      type: "string",
      label: "Subject line",
      description: "The subject line for the campaign.",
      optional: true,
    },
    previewText: {
      type: "string",
      label: "Preview text",
      description: "The preview text for the campaign.",
      optional: true,
    },
    title: {
      type: "string",
      label: "Title",
      description: "The title of the campaign.",
      optional: true,
    },
    fromName: {
      type: "string",
      label: "From name",
      description: "The 'from' name on the campaign (not an email address).",
      optional: true,
    },
    replyTo: {
      type: "string",
      label: "Reply to",
      description: "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.",
      optional: true,
    },
    useConversation: {
      type: "boolean",
      label: "Use conversations",
      description: "Use Mailchimp Conversation feature to manage out-of-office replies.",
      optional: true,
    },
    toName: {
      type: "string",
      label: "To name",
      description: "The campaign's custom 'To' name.",
      optional: true,
    },
    folderId: {
      type: "string",
      label: "Folder ID",
      description: "If the campaign is listed in a folder, the ID for that folder.",
      optional: true,
    },
    authenticate: {
      type: "boolean",
      label: "Authenticate",
      description: "Whether Mailchimp authenticated the campaign. Defaults to true.",
      optional: true,
    },
    autoFooter: {
      type: "boolean",
      label: "Auto footer",
      description: "Automatically append Mailchimp's default footer to the campaign.",
      optional: true,
    },
    inlineCss: {
      type: "boolean",
      label: "Inline css",
      description: "Automatically inline the CSS included with the campaign content.",
      optional: true,
    },
    autoTweet: {
      type: "boolean",
      label: "Auto tweet",
      description: "Automatically tweet a link to the campaign archive page when the campaign is sent.",
      optional: true,
    },
    autoFbPost: {
      type: "string[]",
      label: "Auto facebook post",
      description: "An array of Facebook page ID to auto-post to.",
      optional: true,
    },
    fbComments: {
      type: "boolean",
      label: "Facebook comment",
      description: "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.",
      optional: true,
    },
    templateId: {
      type: "string",
      label: "Template ID",
      description: "The ID of the template to use.",
      optional: true,
    },
    opens: {
      type: "boolean",
      label: "Opens",
      description: "Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    htmlClicks: {
      type: "boolean",
      label: "HTML clicks",
      description: "Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    textClicks: {
      type: "boolean",
      label: "Text clicks",
      description: "Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.",
      optional: true,
    },
    goalTracking: {
      type: "boolean",
      label: "Goal tracking",
      description: "Whether to enable Goal tracking.",
      optional: true,
    },
    ecomm360: {
      type: "boolean",
      label: "E-commerce tracking",
      description: "Whether to enable eCommerce360 tracking.",
      optional: true,
    },
    googleAnalytics: {
      type: "string",
      label: "Google analytics",
      description: "The custom slug for Google Analytics tracking (max of 50 bytes).",
      optional: true,
    },
    clicktale: {
      type: "string",
      label: "Clicktale",
      description: "The custom slug for ClickTale tracking (max of 50 bytes).",
      optional: true,
    },
    salesforceCampaign: {
      type: "boolean",
      label: "Salesforce campaign",
      description: "Create a campaign in a connected Salesforce account.",
      optional: true,
    },
    salesforceNotes: {
      type: "boolean",
      label: "Salesforce notes",
      description: "Update contact notes for a campaign based on subscriber email addresses.",
      optional: true,
    },
    capsuleNotes: {
      type: "boolean",
      label: "Capsule notes",
      description: "Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.",
      optional: true,
    },
    socialImageUrl: {
      type: "string",
      label: "Social image url",
      description: "The url for the header image for the preview card.",
      optional: true,
    },
    socialDescritpion: {
      type: "string",
      label: "Social description",
      description: "A short summary of the campaign to display.",
      optional: true,
    },
    socialTitle: {
      type: "string",
      label: "Social title",
      description: "The title for the preview card. Typically the subject line of the campaign.",
      optional: true,
      options: constants.SOCIAL_TITLES,
    },
  },
  async run({ $ }) {
    const payload = removeNullEntries({
      campaignId: this.campaignId,
      recipients: {
        list_id: this.listId,
        segment_ops: {
          saved_segment_id: this.savedSegmentId,
          prebuilt_segment_id: this.prebuiltSegmentId,
          match: this.segmentMatch,
          conditions: this.segmentConditions,
        },
      },
      settings: {
        subject_line: this.subjectLine,
        preview_text: this.previewText,
        title: this.title,
        from_name: this.fromName,
        reply_to: this.replyTo,
        use_conversation: this.useConversation,
        to_name: this.toName,
        folder_id: this.folderId,
        authenticate: this.authenticate,
        auto_footer: this.autoFooter,
        inline_css: this.inlineCss,
        auto_tweet: this.autoTweet,
        auto_fb_post: this.autoFbPost,
        fb_comments: this.fbComments,
        template_id: this.templateId && Number(this.templateId),
      },
      tracking: {
        opens: this.opens,
        html_clicks: this.htmlClicks,
        text_clicks: this.textClicks,
        goal_tracking: this.goalTracking,
        ecomm360: this.ecomm360,
        google_analytics: this.googleAnalytics,
        clicktale: this.clicktale,
        salesforce: {
          campaign: this.salesforceCampaign,
          notes: this.salesforceNotes,
        },
        capsule: {
          notes: this.capsuleNotes,
        },
      },
      social_card: {
        image_url: this.socialImageUrl,
        description: this.socialDescritpion,
        title: this.socialTitle,
      },
    });
    const response = await this.mailchimp.updateCampaign($, payload);
    response && $.export("$summary", "Campaign updated successfully");
    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
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
List Id	`listId`	`string`	Select a value from the drop down menu.
Saved segment ID	`savedSegmentId`	`string`	Select a value from the drop down menu.
Prebuilt segment ID	`prebuiltSegmentId`	`string`	The prebuilt segment ID, if a prebuilt segment has been designated for this campaign.
Segment match	`segmentMatch`	`string`	Select a value from the drop down menu:`anyall`
Segment condition	`segmentConditions`	`any`	Segment match conditions.
Subject line	`subjectLine`	`string`	The subject line for the campaign.
Preview text	`previewText`	`string`	The preview text for the campaign.
Title	`title`	`string`	The title of the campaign.
From name	`fromName`	`string`	The 'from' name on the campaign (not an email address).
Reply to	`replyTo`	`string`	The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending.
Use conversations	`useConversation`	`boolean`	Use Mailchimp Conversation feature to manage out-of-office replies.
To name	`toName`	`string`	The campaign's custom 'To' name.
Folder ID	`folderId`	`string`	If the campaign is listed in a folder, the ID for that folder.
Authenticate	`authenticate`	`boolean`	Whether Mailchimp authenticated the campaign. Defaults to true.
Auto footer	`autoFooter`	`boolean`	Automatically append Mailchimp's default footer to the campaign.
Inline css	`inlineCss`	`boolean`	Automatically inline the CSS included with the campaign content.
Auto tweet	`autoTweet`	`boolean`	Automatically tweet a link to the campaign archive page when the campaign is sent.
Auto facebook post	`autoFbPost`	`string[]`	An array of Facebook page ID to auto-post to.
Facebook comment	`fbComments`	`boolean`	Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to true.
Template ID	`templateId`	`string`	The ID of the template to use.
Opens	`opens`	`boolean`	Whether to track opens. Defaults to true. Cannot be set to false for variate campaigns.
HTML clicks	`htmlClicks`	`boolean`	Whether to track clicks in the HTML version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
Text clicks	`textClicks`	`boolean`	Whether to track clicks in the plain-text version of the campaign. Defaults to true. Cannot be set to false for variate campaigns.
Goal tracking	`goalTracking`	`boolean`	Whether to enable Goal tracking.
E-commerce tracking	`ecomm360`	`boolean`	Whether to enable eCommerce360 tracking.
Google analytics	`googleAnalytics`	`string`	The custom slug for Google Analytics tracking (max of 50 bytes).
Clicktale	`clicktale`	`string`	The custom slug for ClickTale tracking (max of 50 bytes).
Salesforce campaign	`salesforceCampaign`	`boolean`	Create a campaign in a connected Salesforce account.
Salesforce notes	`salesforceNotes`	`boolean`	Update contact notes for a campaign based on subscriber email addresses.
Capsule notes	`capsuleNotes`	`boolean`	Update contact notes for a campaign based on subscriber email addresses. Must be using Mailchimp's built-in Capsule integration.
Social image url	`socialImageUrl`	`string`	The url for the header image for the preview card.
Social description	`socialDescritpion`	`string`	A short summary of the campaign to display.
Social title	`socialTitle`	`string`	Select a value from the drop down menu:`activeinactive`

Action Authentication#

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

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

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

More Ways to Connect Mailchimp + Google Drive#

Other Popular Integrations#

Add Note to Subscriber with Mailchimp API on Changes to Specific Files from Google Drive API

Google Drive + Mailchimp

Update Campaign with Mailchimp API on Changes to Specific Files from Google Drive API

Pipedream makes it easy to connect APIs for Mailchimp, 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