Update Campaign with Mailchimp API on New Upcoming Event Alert from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert from the Google Calendar 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 Calendar 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 New Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Connect your Google Calendar account
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
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#

New Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) for more information and instructions for connecting your Pipedream account.

Version:0.0.10

Key:google_calendar-upcoming-event-alert

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 taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: `Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler.
    [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) 
    for more information and instructions for connecting your Pipedream account.`,
  version: "0.0.10",
  type: "source",
  props: {
    pipedream: taskScheduler.props.pipedream,
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    const scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, `Upcoming ${event.summary} event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  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	`pipedream`	`app`	This component uses the Google Calendar app.
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.
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.
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

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#

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 Calendar#

Other Popular Integrations#

Create Event with Google Calendar API on Link Clicked from Mailchimp API

Mailchimp + Google Calendar

Update Campaign with Mailchimp API on New Upcoming Event Alert from Google Calendar API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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