Find Email with Gmail API on New Booking Lifecycle Event (Instant) from OnceHub API

Pipedream makes it easy to connect APIs for Gmail, OnceHub and 2,500+ other apps remarkably fast.

Trigger workflow on

New Booking Lifecycle Event (Instant) from the OnceHub API

Next, do this

Find Email with the Gmail 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 OnceHub trigger and Gmail action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Booking Lifecycle Event (Instant) trigger
1. Connect your OnceHub account
Configure the Find Email action
1. Connect your Gmail account
2. Optional- Configure Search Query
3. Configure Return payload as plaintext
4. Optional- Select one or more Labels
5. Optional- Configure Include Spam and Trash?
6. Optional- Configure Max Results
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 Booking Lifecycle Event (Instant) on OnceHub

Description:Emit new event when the status of a booking is changed. [See the docs](https://developers.oncehub.com/reference/create-a-webhook)

Version:0.0.1

Key:oncehub-new-booking-lifecycle-event

View on GitHub

OnceHub Overview#

The OnceHub API is a powerful tool for automating the scheduling of meetings and appointments. With this API, you can dynamically manage bookings, sync calendars, personalize notifications, and streamline the entire process of setting up and following up on appointments. When used on Pipedream, you can harness the serverless power of the platform to trigger workflows based on events in OnceHub, or to act upon data from other services, making the maintenance of your calendar and scheduling needs a breeze.

Trigger Code#

import common from "../common/common-webhook.mjs";

export default {
  ...common,
  key: "oncehub-new-booking-lifecycle-event",
  name: "New Booking Lifecycle Event (Instant)",
  description: "Emit new event when the status of a booking is changed. [See the docs](https://developers.oncehub.com/reference/create-a-webhook)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getHookParams() {
      return {
        name: "Pipedream New Booking Lifecycle Event Subscription",
        events: [
          "booking",
        ],
      };
    },
    generateMeta(booking) {
      const ts = Date.parse(booking.last_updated_time);
      return {
        id: `${booking.id}${ts}`,
        summary: `${booking.subject} status updated`,
        ts,
      };
    },
  },
};

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
OnceHub	`oncehub`	`app`	This component uses the OnceHub app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your OnceHub account and sign in
Go to Settings > API & Webhooks

About OnceHub#

Don't keep your leads waiting. Capture, qualify, and engage with inbound leads in minutes, not days.

Action#

Find Email on Gmail

Description:Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)

Version:0.1.0

Key:gmail-find-email

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Action Code#

import { convert } from "html-to-text";
import gmail from "../../gmail.app.mjs";

export default {
  key: "gmail-find-email",
  name: "Find Email",
  description: "Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)",
  version: "0.1.0",
  type: "action",
  props: {
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    withTextPayload: {
      type: "boolean",
      label: "Return payload as plaintext",
      description: "Convert the payload response into a single text field. **This reduces the size of the payload and makes it easier for LLMs work with.**",
      default: false,
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      description: "Only return messages with labels that match all of the specified labels.",
      optional: true,
    },
    includeSpamTrash: {
      type: "boolean",
      label: "Include Spam and Trash?",
      description: "Include messages from `SPAM` and `TRASH` in the results. Defaults to `false`.",
      optional: true,
      default: false,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of messages to return. Defaults to `100`.",
      default: 100,
      optional: true,
    },
  },
  async run({ $ }) {
    const { messages = [] } = await this.gmail.listMessages({
      q: this.q,
      labelIds: this.labels,
      includeSpamTrash: this.includeSpamTrash,
      maxResults: this.maxResults,
    });
    const messageIds = messages.map(({ id }) => id);
    let messagesToEmit = await this.gmail.getMessages(messageIds);

    for await (const message of messagesToEmit) {
      let newPayload = "";
      for (const part of message.payload?.parts || []) {
        if (part.body.data) {
          const payload = Buffer.from(part.body.data, "base64").toString("utf-8");
          this.withTextPayload
            ? newPayload += convert(payload)
            : part.body.text = payload;
        }
      }
      if (this.withTextPayload) {
        message.payload = newPayload;
      }
    }

    const suffix = messagesToEmit.length === 1
      ? ""
      : "s";
    $.export("$summary", `Successfully found ${messagesToEmit.length} message${suffix}`);
    return messagesToEmit;
  },
};

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
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Return payload as plaintext	`withTextPayload`	`boolean`	Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with.
Labels	`labels`	`string[]`	Select a value from the drop down menu.
Include Spam and Trash?	`includeSpamTrash`	`boolean`	Include messages from `SPAM` and `TRASH` in the results. Defaults to `false`.
Max Results	`maxResults`	`integer`	Maximum number of messages to return. Defaults to `100`.

Action Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

Find Email with Gmail API on New Booking Lifecycle Event (Instant) from OnceHub API

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