Send Fax with Telnyx API on New Upcoming Event Alert from Google Calendar API

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

Trigger workflow on

New Upcoming Event Alert from the Google Calendar API

Next, do this

Send Fax with the Telnyx 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 Telnyx 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 Send Fax action
1. Connect your Telnyx account
2. Select a Fax Application ID
3. Configure Media URL
4. Select a Phone Number
5. Configure To
6. Optional- Configure From Display Name
7. Optional- Select a Quality
8. Optional- Configure TS38 Enabled
9. Optional- Configure Monochrome
10. Optional- Configure Store Media
11. Optional- Configure Webhook URL
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.9

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.9",
  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.readonly

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#

Send Fax on Telnyx

Description:Sends a PDF document to a specified fax number using the Telnyx Fax API. [See the documentation](https://developers.telnyx.com/api/programmable-fax/send-fax)

Version:0.0.1

Key:telnyx-send-fax

View on GitHub

Telnyx Overview#

The Telnyx API offers a suite of telecommunication features enabling developers to manage voice, SMS, and other real-time communications. With Telnyx, you can programmatically send and receive text messages, handle voice calls, and control other telephony services using their robust API. Leveraging Pipedream's capabilities, this API can be hooked into workflows to automate complex tasks, react to incoming messages or calls, and integrate with countless other services for analytics, customer support, and more.

Action Code#

import telnyxApp from "../../telnyx.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "telnyx-send-fax",
  name: "Send Fax",
  description: "Sends a PDF document to a specified fax number using the Telnyx Fax API. [See the documentation](https://developers.telnyx.com/api/programmable-fax/send-fax)",
  version: "0.0.1",
  type: "action",
  props: {
    telnyxApp,
    faxAppId: {
      propDefinition: [
        telnyxApp,
        "faxAppId",
      ],
    },
    mediaUrl: {
      type: "string",
      label: "Media URL",
      description: "The URL to the PDF used for the fax's media.",
    },
    phoneNumber: {
      propDefinition: [
        telnyxApp,
        "phoneNumber",
      ],
    },
    to: {
      type: "string",
      label: "To",
      description: "The phone number, in E.164 format, the fax will be sent to or SIP URI",
    },
    fromDisplayName: {
      type: "string",
      label: "From Display Name",
      description: "The string to be used as the caller id name (SIP From Display Name) presented to the destination (to number).",
      optional: true,
    },
    quality: {
      type: "string",
      label: "Quality",
      description: "The quality of the fax. The `ultra` settings provides the highest quality available, but also present longer fax processing times. `ultra_light` is best suited for images, while `ultra_dark` is best suited for text.",
      optional: true,
      options: Object.values(constants.faxQualities),
    },
    ts38Enabled: {
      type: "boolean",
      label: "TS38 Enabled",
      description: "The flag to disable the T.38 protocol",
      optional: true,
    },
    monochrome: {
      type: "boolean",
      label: "Monochrome",
      description: "The flag to enable monochrome, `true` creates black and white fax results.",
      optional: true,
    },
    storeMedia: {
      type: "boolean",
      label: "Store Media",
      description: "Should fax media be stored on temporary URL?",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.telnyxApp.sendFax({
      $,
      data: {
        connection_id: this.faxAppId,
        media_url: this.mediaUrl,
        from: this.phoneNumber,
        to: this.to,
        from_display_name: this.fromDisplayName,
        quality: this.quality,
        ts38_enabled: this.ts38Enabled,
        monochrome: this.monochrome,
        store_media: this.storeMedia,
        webhook_url: this.webhookUrl,
      },
    });
    $.export("$summary", `Successfully sent fax with Id: ${response.data.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
Telnyx	`telnyxApp`	`app`	This component uses the Telnyx app.
Fax Application ID	`faxAppId`	`string`	Select a value from the drop down menu.
Media URL	`mediaUrl`	`string`	The URL to the PDF used for the fax's media.
Phone Number	`phoneNumber`	`string`	Select a value from the drop down menu.
To	`to`	`string`	The phone number, in E.164 format, the fax will be sent to or SIP URI
From Display Name	`fromDisplayName`	`string`	The string to be used as the caller id name (SIP From Display Name) presented to the destination (to number).
Quality	`quality`	`string`	Select a value from the drop down menu:`normalhighvery_highultra_lightultra_dark`
TS38 Enabled	`ts38Enabled`	`boolean`	The flag to disable the T.38 protocol
Monochrome	`monochrome`	`boolean`	The flag to enable monochrome, `true` creates black and white fax results.
Store Media	`storeMedia`	`boolean`	Should fax media be stored on temporary URL?
Webhook URL	`webhookUrl`	`string`	Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.

Action Authentication#

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

The Telnyx API V2 uses API Keys to authenticate requests. You can view and manage your API Keys by logging into your Mission Control Portal account and navigating to the Auth V2 tab in the "Auth" section. See docs.

About Telnyx#

Connectivity Made Simple

More Ways to Connect Telnyx + Google Calendar#

Other Popular Integrations#

Get Messaging Profiles with Telnyx API on New Cancelled Event from Google Calendar API

Google Calendar + Telnyx

Send Fax with Telnyx API on New Upcoming Event Alert from Google Calendar API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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