Save Event to Firestore with Firebase Admin SDK API on New Document in Firestore Collection from Firebase Admin SDK API

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

Trigger workflow on

New Document in Firestore Collection from the Firebase Admin SDK API

Next, do this

Save Event to Firestore 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 Firebase Admin SDK 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 Document in Firestore Collection trigger
1. Connect your Firebase Admin SDK account
2. Configure Polling Interval
3. Optional- Select a Database Region
4. Configure Structured Query
Configure the Save Event to Firestore action
1. Connect your Firebase Admin SDK account
2. Configure deliveryId
3. Configure firestoreCollection
4. Configure data
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 Document in Firestore Collection on Firebase Admin SDK

Description:Emit new event when a structured query returns new documents

Version:0.0.6

Key:firebase_admin_sdk-new-doc-in-firestore-collection

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.

Trigger Code#

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

export default {
  ...common,
  key: "firebase_admin_sdk-new-doc-in-firestore-collection",
  name: "New Document in Firestore Collection",
  description: "Emit new event when a structured query returns new documents",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    query: {
      propDefinition: [
        common.props.firebase,
        "query",
      ],
    },
  },
  methods: {
    ...common.methods,
    async processEvent() {
      const structuredQuery = JSON.parse(this.query);

      const queryResults = await this.firebase.runQuery(structuredQuery);

      for (const result of queryResults) {
        const meta = this.generateMeta(result);
        this.$emit(result, meta);
      }
    },
    generateMeta({ document }) {
      const {
        name,
        createTime,
      } = document;
      const id = name.substring(name.lastIndexOf("/") + 1);
      return {
        id,
        summary: name,
        ts: Date.parse(createTime),
      };
    },
  },
};

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
Firebase Admin SDK	`firebase`	`app`	This component uses the Firebase Admin SDK app.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
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" }`
Structured Query	`query`	`string`	Enter a structured query that returns new records from your target collection. Example: `{ "select": { "fields": [] }, "from": [ { "collectionId": "<YOUR COLLECTION>", "allDescendants": "true" } ] }`

Trigger 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.

Action#

Save Event to Firestore on Firebase Admin SDK

Description:Replicate event in Firestore

Version:0.4.4

Key:firebase_admin_sdk-replicate-event-firestore

View on GitHub

Firebase Admin SDK Overview#

Action Code#

// legacy_hash_id: a_rJipb5
import admin from "firebase-admin";
import lodash from "lodash";

export default {
  key: "firebase_admin_sdk-replicate-event-firestore",
  name: "Save Event to Firestore",
  description: "Replicate event in Firestore",
  version: "0.4.4",
  type: "action",
  props: {
    firebase_admin_sdk: {
      type: "app",
      app: "firebase_admin_sdk",
    },
    deliveryId: {
      type: "string",
    },
    firestoreCollection: {
      type: "string",
    },
    data: {
      type: "string",
    },
  },
  async run({ $ }) {
    // Enter values for the following parameters below this code step,
    // These get passed to the initializeApp method below.
    const {
      projectId,
      clientEmail,
      privateKey,
    } = this.firebase_admin_sdk.$auth;

    // Before passing the privateKey to the initializeApp constructor,
    // we have to replace newline characters with literal newlines
    const formattedPrivateKey = privateKey.replace(/\\n/g, "\n");

    const app = admin.initializeApp({
      credential: admin.credential.cert({
        projectId,
        clientEmail,
        privateKey: formattedPrivateKey,
      }),
    });

    const db = admin.firestore();
    const deliveryId = this.deliveryId;

    let updates = [];
    updates.push(`updating ${deliveryId}`);

    const p1 = db.collection(this.firestoreCollection).doc(deliveryId)
      .set(lodash.assign({}, this.data, {
        pipedream: {
          updatedAt: (new Date().toISOString()),
        },
      }))
      .then(function () {
        updates.push("Updated successfully");
        app.delete().then(function () {
          updates.push("App deleted successfully");
        })
          .catch(function (error) {
            updates.push("Error deleting app:", error);
          });
      })
      .catch(function (error) {
        updates.push("Error writing:", error);
      });

    const result = await Promise.all([
      p1,
    ]);

    $.export("updates", updates);

    return result;
  },
};

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_admin_sdk`	`app`	This component uses the Firebase Admin SDK app.
deliveryId	`deliveryId`	`string`
firestoreCollection	`firestoreCollection`	`string`
data	`data`	`string`

Action Authentication#

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.