Create Letter with Lob API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Lob, 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 Letter with the Lob 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 Lob 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 Letter action
1. Connect your Lob account
2. Select a To
3. Configure Description
4. Select a From
5. Optional- Configure Name
6. Optional- Configure Company
7. Optional- Configure Email
8. Optional- Configure Phone
9. Optional- Configure Address Line 1
10. Optional- Configure Address Line 2
11. Optional- Configure City
12. Optional- Configure State
13. Optional- Configure ZIP Code
14. Optional- Configure Country
15. Configure File
16. Configure Color
17. Select a Use Type
18. Optional- Select a Mail Type
19. Optional- Configure Send Date
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 Letter on Lob

Description:Creates a new letter. [See docs here](https://docs.lob.com/#tag/Letters/operation/letter_create).

Version:0.0.2

Key:lob-create-letter

View on GitHub

Lob Overview#

The Lob API provides a suite of automation capabilities focused on direct mail, address verification, and print management. With Lob, you can automate the sending of physical mail programmatically, verify addresses to ensure deliverability, and manage printing logistics for marketing campaigns or operational needs. It's a powerful tool for bridging the digital and physical mailing worlds, particularly useful for marketing, billing, and compliance communications.

Action Code#

import { defineAction } from "@pipedream/types";
import lob from "../../app/lob.app.mjs";
import constants from "../../app/common/constants.mjs";
export default defineAction({
    key: "lob-create-letter",
    name: "Create Letter",
    description: "Creates a new letter. [See docs here](https://docs.lob.com/#tag/Letters/operation/letter_create).",
    version: "0.0.2",
    annotations: {
        destructiveHint: false,
        openWorldHint: true,
        readOnlyHint: false,
    },
    type: "action",
    props: {
        lob,
        to: {
            propDefinition: [
                lob,
                "addressId",
            ],
            label: "To",
            description: "Must either be an `addressId` or an inline object with correct address parameters",
        },
        description: {
            type: "string",
            label: "Description",
            description: "An internal description that identifies this resource",
        },
        from: {
            propDefinition: [
                lob,
                "addressId",
            ],
            label: "From",
            description: "Required if `to` address is international. Must either be an `addressId` or an inline object with correct address parameters",
        },
        name: {
            type: "string",
            label: "Name",
            description: "Name of the recipient.",
            optional: true,
        },
        company: {
            type: "string",
            label: "Company",
            description: "Company name associated with the recipient.",
            optional: true,
        },
        email: {
            type: "string",
            label: "Email",
            description: "Email address of the recipient.",
            optional: true,
        },
        phone: {
            type: "string",
            label: "Phone",
            description: "Phone number of the recipient.",
            optional: true,
        },
        addressLine1: {
            type: "string",
            label: "Address Line 1",
            description: "First line of the address.",
            optional: true,
        },
        addressLine2: {
            type: "string",
            label: "Address Line 2",
            description: "Second line of the address.",
            optional: true,
        },
        addressCity: {
            type: "string",
            label: "City",
            description: "City of the address.",
            optional: true,
        },
        addressState: {
            type: "string",
            label: "State",
            description: "State of the address.",
            optional: true,
        },
        addressZip: {
            type: "string",
            label: "ZIP Code",
            description: "ZIP code of the address.",
            optional: true,
        },
        addressCountry: {
            type: "string",
            label: "Country",
            description: "Country of the address.",
            optional: true,
        },
        file: {
            type: "string",
            label: "File",
            description: "Letter content in HTML",
        },
        color: {
            type: "boolean",
            label: "Color",
            description: "Set to true if you want to print in color; set to false for black and white.",
        },
        useType: {
            type: "string",
            label: "Use Type",
            description: "The use type of the mail. It can only be null if an account default use_type is selected).",
            options: constants.USE_TYPES,
        },
        mailType: {
            type: "string",
            label: "Mail Type",
            description: "Designates the mail postage type.",
            options: constants.MAIL_TYPES,
            optional: true,
        },
        sendDate: {
            type: "string",
            label: "Send Date",
            description: "Specifies the date to send the letter off for production (ISO 8601 format, up to 180 days in the future).",
            optional: true,
        },
    },
    async run({ $ }) {
        const response = await this.lob.createLetter({
            to: this.to ?? {
                name: this.name,
                company: this.company,
                email: this.email,
                phone: this.phone,
                address_line1: this.addressLine1,
                address_line2: this.addressLine2,
                address_city: this.addressCity,
                address_state: this.addressState,
                address_zip: this.addressZip,
                address_country: this.addressCountry,
            },
            description: this.description,
            from: this.from,
            file: this.file,
            color: this.color,
            use_type: this.useType,
            mail_type: this.mailType,
            send_date: this.sendDate,
        });
        $.export("$summary", `Successfully created letter with ID ${response.id}`);
        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
Lob	`lob`	`app`	This component uses the Lob app.
To	`to`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	An internal description that identifies this resource
From	`from`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the recipient.
Company	`company`	`string`	Company name associated with the recipient.
Email	`email`	`string`	Email address of the recipient.
Phone	`phone`	`string`	Phone number of the recipient.
Address Line 1	`addressLine1`	`string`	First line of the address.
Address Line 2	`addressLine2`	`string`	Second line of the address.
City	`addressCity`	`string`	City of the address.
State	`addressState`	`string`	State of the address.
ZIP Code	`addressZip`	`string`	ZIP code of the address.
Country	`addressCountry`	`string`	Country of the address.
File	`file`	`string`	Letter content in HTML
Color	`color`	`boolean`	Set to true if you want to print in color; set to false for black and white.
Use Type	`useType`	`string`	Select a value from the drop down menu:`{ "label": "Marketing", "value": "marketing" }{ "label": "Operational", "value": "operational" }`
Mail Type	`mailType`	`string`	Select a value from the drop down menu:`usps_first_classusps_standard`
Send Date	`sendDate`	`string`	Specifies the date to send the letter off for production (ISO 8601 format, up to 180 days in the future).

Action Authentication#

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

Enter your Live Lob secret API key below.

You can find this key under your account settings in the Lob dashboard

Alternatively, you can use your Test Secret API Key, but you'll need to create a new Lob Connected Account in Pipedream in order to make Live requests.

About Lob#

Direct Mail Automation and Address Verification APIs

More Ways to Connect Lob + Google Calendar#

Other Popular Integrations#

Cancel Postcard with Lob API on Event Cancelled from Google Calendar API

Google Calendar + Lob

Create Letter with Lob API on New Upcoming Event Alert from Google Calendar API

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