Create Document with Firebase Admin SDK API on New Email Matching Search from Gmail API

Pipedream makes it easy to connect APIs for Firebase Admin SDK, Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Email Matching Search from the Gmail API

Next, do this

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

Select this integration
Configure the New Email Matching Search trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
Configure the Create Document action
1. Connect your Firebase Admin SDK account
2. Optional- Select a Database Region
3. Select a Collection
4. Configure Data
5. Optional- Configure Custom ID
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 Email Matching Search on Gmail

Description:Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

Version:0.0.4

Key:gmail-new-email-matching-search

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.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  key: "gmail-new-email-matching-search",
  name: "New Email Matching Search",
  description: "Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getLabels() {
      return this.labels;
    },
    generateMeta(message) {
      const selectedHeader = message.payload.headers.find(({ name }) => name === "Subject");
      const subject = selectedHeader?.value || "No subject";
      return {
        id: message.id,
        summary: `New email: ${subject}`,
        ts: +message.internalDate,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger 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

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Create Document on Firebase Admin SDK

Description:Creates a New Document. [See the documentation](https://googleapis.dev/nodejs/firestore/latest/CollectionReference.html#add)

Version:0.0.8

Key:firebase_admin_sdk-create-document

View on GitHub

Firebase Admin SDK Overview#

The Firebase Admin SDK API provides powerful backend functionality for Firebase apps. It allows you to interact with Firebase services like Firestore, Firebase Realtime Database, Firebase Storage, and Firebase Authentication directly from a server. With Pipedream, you can harness this API to automate complex workflows, respond to Firebase events in real-time, and integrate with countless other services.

Action Code#

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

export default {
  ...common,
  key: "firebase_admin_sdk-create-document",
  name: "Create Document",
  description: "Creates a New Document. [See the documentation](https://googleapis.dev/nodejs/firestore/latest/CollectionReference.html#add)",
  version: "0.0.8",
  type: "action",
  props: {
    ...common.props,
    collection: {
      propDefinition: [
        common.props.firebase,
        "collection",
        (c) => ({
          region: c.databaseRegion,
        }),
      ],
    },
    data: {
      propDefinition: [
        common.props.firebase,
        "data",
      ],
    },
    customId: {
      label: "Custom ID",
      description: "Set this custom ID for the created document",
      type: "string",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    async getResponse() {
      const data = this.parseBooleanValues(this.data);
      return this.firebase.createDocument(this.collection, data, this.customId);
    },
    emitSummary($, response) {
      $.export("$summary", `Successfully added document ${response?._path?.segments[1] ?? ""}`);
    },
  },
};

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
Firebase Admin SDK	`firebase`	`app`	This component uses the Firebase Admin SDK app.
Database Region	`databaseRegion`	`string`	Select a value from the drop down menu:`{ "label": "us-central1", "value": "firebaseio.com" }{ "label": "europe-west1", "value": "europe-west1.firebasedatabase.app" }{ "label": "asia-southeast1", "value": "asia-southeast1.firebasedatabase.app" }`
Collection	`collection`	`string`	Select a value from the drop down menu.
Data	`data`	`object`	An Object containing the data for the new document
Custom ID	`customId`	`string`	Set this custom ID for the created document

Action Authentication#

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

Enable the Cloud Firestore API on your Firebase account, and make sure you've created at least one collection in the database.
Follow these instructions to generate a private key tied to your Firebase service account. This will generate a JSON file that contains the project ID, private key, and client email that you should paste below.
When entering the private key, please add the full string included in the JSON file, from -----BEGIN PRIVATE KEY----- to -----END PRIVATE KEY-----, with all newline characters included.

About Firebase Admin SDK#

Firebase is Google's mobile platform that helps you quickly develop high-quality apps and grow your business.

More Ways to Connect Firebase Admin SDK + Gmail#

Other Popular Integrations#

Save Event to Firestore with Firebase Admin SDK API on New Labeled Email from Gmail API

Gmail + Firebase Admin SDK

Create Document with Firebase Admin SDK API on New Email Matching Search from Gmail API

Pipedream makes it easy to connect APIs for Firebase Admin SDK, Gmail and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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