New Document in Firestore Collection from Firebase Admin SDK API

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

Connect to 2,400+ APIs using code and no-code building blocks

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#

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.

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
Add steps to connect to 2,400+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Document with Firebase Admin SDK API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + Firebase Admin SDK

Try it

Generate Content from Text with Google Gemini API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + Google Gemini

Try it

Merge RSS Feeds with RSS API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + RSS

Try it

Send Message with Discord API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + Discord

Try it

Send Message with Discord Webhook API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + Discord Webhook

Try it

Details#

This is a pre-built, source-available 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.7

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

View on GitHub

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

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" } ] }`

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.