← Firebase Admin SDK

New Document in Firestore Collection from Firebase Admin SDK API

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

Trigger workflow on
New Document in Firestore Collection from the Firebase Admin SDK API
Next, do this
Connect to 800+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Document in Firestore Collection with Firebase Admin SDK API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Document in Firestore Collection trigger
    1. Connect your Firebase Admin SDK account
    2. Configure Polling Interval
    3. Configure Structured Query
  2. Add steps to connect to 800+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

New Document in Firestore Collection on Firebase Admin SDK
Description:Emit new event when a structured query returns new documents
Version:0.0.2
Key:firebase_admin_sdk-new-doc-in-firestore-collection

Code

import common from "../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.2",
  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),
      };
    },
  },
};

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.
LabelPropTypeDescription
Firebase Admin SDKfirebaseappThis component uses the Firebase Admin SDK app.
Polling Intervaltimer$.interface.timer

Pipedream will poll the API on this schedule

Structured Queryquerystring

Enter a structured query that returns new records from your target collection. Example: { "select": { "fields": [] }, "from": [ { "collectionId": "<YOUR COLLECTION>", "allDescendants": "true" } ] }

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.

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.