Create Email Marketing Campaign with VBOUT API on New Upcoming Event Alert from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert from the Google Calendar API

Next, do this

Create Email Marketing Campaign with the VBOUT 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 VBOUT 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. Configure Pipedream API Key
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
Configure the Create Email Marketing Campaign action
1. Connect your VBOUT account
2. Configure Name
3. Configure Subject
4. Configure From Email
5. Configure From Name
6. Configure Reply To
7. Configure Body
8. Optional- Select a Type
9. Optional- Configure Is Scheduled
10. Optional- Configure Is Draft
11. Optional- Configure Scheduled Datetime
12. Select one or more Audiences
13. Optional- Select one or more List
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.

Version:0.1.0

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 googleCalendar from "../../google_calendar.app.mjs";
import taskScheduler from "../common/taskScheduler.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.",
  version: "0.1.0",
  type: "source",
  props: {
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    pipedreamApiKey: {
      type: "string",
      label: "Pipedream API Key",
      description: "[Click here to find your Pipedream API key](https://pipedream.com/settings/user)",
      secret: true,
    },
    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.deleteScheduledEvent({
          body: {
            id,
          },
        }, this.pipedreamApiKey)) {
          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(this.pipedreamApiKey);
    }

    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.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	`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.
Pipedream API Key	`pipedreamApiKey`	`string`	Click here to find your Pipedream API key
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#

Create Email Marketing Campaign on VBOUT

Description:This action creates a new email marketing campaign. [See the docs here](https://developers.vbout.com/docs#emailmarketing_addcampaign)

Version:0.0.2

Key:vbout-create-email-marketing-campaign

View on GitHub

VBOUT Overview#

The VBOUT API unlocks the potential to automate your marketing stack, leveraging Pipedream's capabilities for seamless integrations with other services. With VBOUT, you can manage contacts, automate email campaigns, track user actions, and analyze performance data. Pipedream enhances this by allowing you to capture events in real-time, process data with serverless code, and connect with countless apps to extend your marketing automation workflows.

Action Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "vbout-create-email-marketing-campaign",
  name: "Create Email Marketing Campaign",
  description: "This action creates a new email marketing campaign. [See the docs here](https://developers.vbout.com/docs#emailmarketing_addcampaign)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    ...common.props,
    name: {
      propDefinition: [
        common.props.vbout,
        "name",
      ],
      description: "Name of the campaign.",
    },
    subject: {
      propDefinition: [
        common.props.vbout,
        "subject",
      ],
    },
    fromEmail: {
      propDefinition: [
        common.props.vbout,
        "fromEmail",
      ],
      description: "The From email of the campaign.",
    },
    fromName: {
      propDefinition: [
        common.props.vbout,
        "fromName",
      ],
      description: "The From name of the campaign.",
    },
    replyTo: {
      propDefinition: [
        common.props.vbout,
        "replyTo",
      ],
      description: "The Reply to email of the campaign.",
    },
    body: {
      propDefinition: [
        common.props.vbout,
        "body",
      ],
    },
    type: {
      propDefinition: [
        common.props.vbout,
        "type",
      ],
      optional: true,
    },
    isScheduled: {
      propDefinition: [
        common.props.vbout,
        "isScheduled",
      ],
      optional: true,
    },
    isDraft: {
      propDefinition: [
        common.props.vbout,
        "isDraft",
      ],
      optional: true,
    },
    scheduledDatetime: {
      propDefinition: [
        common.props.vbout,
        "scheduledDatetime",
      ],
      optional: true,
    },
    audiences: {
      propDefinition: [
        common.props.vbout,
        "audiences",
      ],
    },
    lists: {
      propDefinition: [
        common.props.vbout,
        "listArray",
      ],
      optional: true,
    },
  },
  methods: {
    async processEvent($) {
      const {
        name,
        subject,
        fromEmail,
        fromName,
        replyTo,
        body,
        type,
        isScheduled,
        isDraft,
        scheduledDatetime,
        audiences,
        lists,
      } = this;
      return this.vbout.createCampaign({
        $,
        params: {
          name,
          subject,
          fromemail: fromEmail,
          from_name: fromName,
          reply_to: replyTo,
          body,
          type,
          isscheduled: isScheduled,
          isdraft: isDraft,
          scheduled_datetime: scheduledDatetime,
          audiences: audiences && audiences.toString(),
          lists: lists && lists.toString(),
        },
      });
    },
    getSummary() {
      return `Marketing Campaign "${this.name}" Successfully created!`;
    },
  },
};

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
VBOUT	`vbout`	`app`	This component uses the VBOUT app.
Name	`name`	`string`	Name of the campaign.
Subject	`subject`	`string`	The subject line for the campaign.
From Email	`fromEmail`	`string`	The From email of the campaign.
From Name	`fromName`	`string`	The From name of the campaign.
Reply To	`replyTo`	`string`	The Reply to email of the campaign.
Body	`body`	`string`	Message body.
Type	`type`	`string`	Select a value from the drop down menu:`standardautomated`
Is Scheduled	`isScheduled`	`boolean`	The flag to schedule the campaign for the future.
Is Draft	`isDraft`	`boolean`	The flag to set the campaign to draft.
Scheduled Datetime	`scheduledDatetime`	`string`	The date and time to schedule the campaign. Date format accepted: m/d/Y \| Y-m-d
Audiences	`audiences`	`string[]`	Select a value from the drop down menu.
List	`lists`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API key,

Navigate to your VBOUT account and sign in
Go to “Settings” > “API Integrations”

About VBOUT#

VBOUT offers several marketing tools into one powerful platform: Social media, landing pages, lead management, email marketing, automation and analytics.

More Ways to Connect VBOUT + Google Calendar#

Other Popular Integrations#

Add Contact To List By Email with VBOUT API on Event Cancelled from Google Calendar API

Google Calendar + VBOUT

Create Email Marketing Campaign with VBOUT API on New Upcoming Event Alert from Google Calendar API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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