[Data] Convert JSON to String with Formatting API on New Child Object in a Realtime Database from Firebase Admin SDK API

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

Trigger workflow on

New Child Object in a Realtime Database from the Firebase Admin SDK API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Child Object in a Realtime Database trigger
1. Connect your Firebase Admin SDK account
2. Configure Polling Interval
3. Optional- Select a Database Region
4. Configure Path
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 Child Object in a Realtime Database on Firebase Admin SDK

Description:Emit new event when a new child object is discovered within a specific path

Version:0.0.7

Key:firebase_admin_sdk-new-child-object

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-child-object",
  name: "New Child Object in a Realtime Database",
  description: "Emit new event when a new child object is discovered within a specific path",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    path: {
      propDefinition: [
        common.props.firebase,
        "path",
      ],
    },
  },
  methods: {
    ...common.methods,
    async processEvent(event) {
      const { timestamp } = event;
      const ref = this.firebase.getApp().database()
        .ref(this.path);
      const snapshot = await ref.get();
      const children = snapshot.val() || {};
      for (const [
        key,
        value,
      ] of Object.entries(children)) {
        const meta = this.generateMeta(key, timestamp);
        const child = {
          [key]: value,
        };
        this.$emit(child, meta);
      }
    },
    generateMeta(key, timestamp) {
      return {
        id: key,
        summary: `New child object: ${key}`,
        ts: timestamp,
      };
    },
  },
};

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" }`
Path	`path`	`string`	A relative path to the location of child data

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#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});