Firebase Auth, Firestore & Storage (plugin)
  • 🚀Getting Started
  • Setup
    • Create a Firebase Project
    • Get Firebase access credentials
    • Offline Support
    • Secure your credentials and data
      • Restrict your api-key to your domain
      • Security Rules on Firebase
  • Plugin Elements
    • 🛠️About elements
    • 💾Data Schemas
    • Firebase Auth (Current User)
    • Firestore Data List
      • Firebase Geohash
      • Firestore Data (legacy)
    • Firestore Data Extractor
    • Firestore Data Single
    • Firestore Data Aggregation
    • Firestore Data Processor
    • Firebase Storage Upload Button
    • Firebase Action Listener
    • Firebase Dropdown Processor
  • Plugin Front-end Actions
    • 💻About front-end actions
    • 💾Field types table
    • Firestore
      • Create a new document
      • Update a document
      • Delete a document
      • Update a list of documents
      • Delete a list of documents
      • Batch Operations
        • Batch Operation Constructor
        • Batch Operation Commit
    • Firebase Auth
      • Sign the User Up
      • Log the User In
      • Log the User In with Google
      • Log the User In with Facebook
      • Log the User In with GitHub
      • Log the User Out
      • Update User's Profile
      • Update User's Password
      • Update User's Email
      • Send password reset email
        • Handle reset password code
      • Send verification email
        • Handle verify email code
      • Delete current user
    • Firebase Storage
      • Upload file base64
      • Delete uploaded file
  • Plugin Back-end Actions
    • ☁️About backend actions
    • Firestore Backend
      • Get a list of documents
      • Get a single document
      • Count a list of documents
      • Create a new document
      • Update a document
      • Delete a document
      • Update a list of documents
      • Delete a list of documents
    • Firebase Auth Backend
      • Create an account for someone else
      • Update another user's profile info
      • Delete a user account
      • Generate email confirmation link
      • Generate password reset link
      • Set user roles
Powered by GitBook
On this page
  • Inputs and Settings
  • Collection
  • Custom Doc ID (optional)
  • Merge if document exists
  • Trigger ID (optional)
  • Fields
  • Field Types
  • Triggered events
  • Stored values on the listener
  • New Document ID
  • Error Message
  1. Plugin Front-end Actions
  2. Firestore

Create a new document

PreviousFirestoreNextUpdate a document

Last updated 11 months ago

This action allows you to create a new document in a Firestore collection.

The neat part here of Firestore is that it doesn't need to have the collection or "table schema" pre-determined. The collection is created by this very action, when you create it's first document.


Inputs and Settings

Collection

The name or ID of the collection you want to store the document in.

Custom Doc ID (optional)

You can optionally choose a custom ID for the document. This can be useful in some cases. For instance, if you're generating a charge on a service like Stripe, you can link a charge document you create to the charge on Stripe by making them have the same ID.

If left blank, Firestore you generate a Document ID automatically.

Merge if document exists

If the Custom Doc ID field is set, and there is already a document on the collection with the same ID, this option defines how it will handle this conflicting data.

  • If checked, the action will behave as an "update" operation on the existing document.

  • If unchecked, the action will overwrite the existing document, deleting all fields you didn't specify.

Trigger ID (optional)

If left blank, all listener on the page with blank ID's will be triggered at the same time, so we suggest to always define a Trigger ID.

Fields

When you create a document on Firestore, you must inform which fields and which content each will have on it's structure, in JSON format. This input allows you to set as many fields as you want.

Field Types

For each key/value pair you define and provide a value on the Fields list, you must provide the same key, but with the type of the value, on the Field Types input. That allows the plugin to turn the texts being fed into the plugin into corresponding values on the JSON structure sent to Firestore.

If the number of Fields and Field Types don't match, the action will result in an error.


Triggered events

  • Document Created (if the action was successful)

  • Error in Action (if an error occurs)


Stored values on the listener

New Document ID

The ID of the document created by the action.

Error Message

If an error occurs, you can check its details on this state on the action listener.

This will link the action with a of the same ID.

When the function finishes running, it will trigger the event, storing the on the listener's state.

For each field you must specify the "key" and the "value" that will be stored. For instance, you might want to store the description of a task, as in our , you'd need to define the "key" = "description" and the "value" = "Your description (you can miss the quotes)".

See the to see which types are currently supported by the plugin and how to define them.

Those events are triggered by an with the same ID as the provided on the action.

Action Listener
Document Created
New Document ID
task manager sample app
field types table
Action Listener
Trigger ID