Elements Manual
Elements 3 Manual
Elements 3 Manual
  • Welcome 👋
  • QUICK START
    • Elements in Five Minutes or Less
    • Accessing the Web UI (CRM)
    • Creating A User
  • General
    • General Concepts
    • N-Tier Architecture
    • Security Model
  • Core Features
    • Core API Overview
    • Sessions
    • Applications
    • Users and Profiles
    • Digital Goods
    • Progress and Missions
    • Leaderboards
    • Matchmaking
    • Followers
    • Friends
    • Reward Issuance
    • Save Data
    • Schemas and Metadata Specifications
    • Queries
      • Base Query Syntax
      • Boolean Queries
      • Object Graph Navigation
      • Advanced Operators
        • .ref
        • .name
    • Custom Code
      • Element Structure
      • RESTful APIs
      • Websockets
    • Auth Schemes
      • OIDC
      • OAuth2
  • Web 3
    • Omni Chain Support
    • Vaults
    • Wallets
    • Smart Contracts
      • Smart Contracts: Ethereum
      • Smart Contracts: Flow
      • Smart Contracts: Solana
      • Smart Contracts: Neo
  • CONFIGURATION
    • Direct Database Access and Batch Configuration
    • Batch Samples
      • Item Upload Bash Script Sample
      • Mission Upload Bash Script Sample
  • RESTful APIs
    • Swagger and Swagger UI
    • API Specification
      • /application
      • /application/configuration
      • /auth
      • /auth_scheme
        • /custom
        • /oauth2
        • /oidc
      • /blockchain
      • /followee
      • /follower
      • /friend
      • /google
      • /index
      • /inventory
      • /item
      • /large_object
      • /leaderboard
      • /rank
      • /score
      • /match
      • /mission
      • /progress
      • /reward_issuance
      • /schedule
      • /notification
      • /profile
      • /save_data
      • /metadata_spec
      • /mock_session
      • /session
      • /health
      • /version
      • /signup
      • /user
    • Javadocs
  • Releases
    • 3.1 Release Notes
Powered by GitBook
On this page
  1. Core Features
  2. Applications

Firebase Application Configuration

Configure Firebase as an application in your Elements installation so you can take advantage of push notifications.

Last updated 2 months ago

The Firebase application configuration is used to give your Elements application access to Firebase push notifications for iOS and Android apps.

  1. You will need to create a project on the Firebase console.

  2. Set up your app for iOS and/or Android in your firebase project. You may need to follow additional steps such as configuring your APNs key in Firebase. Refer to the Firebase documentation to get all of this set up.

  3. Inside the project settings, go to Service Accounts. Under Firebase Admin SDK, and generate a new private key. This will generate a key that you will download. Keep this key in a secure place as it cannot be retrieved.

When you set up a Firebase application configuration in Elements, you will need the Firebase Project ID and the private key from the above steps.

  1. Edit an application in Elements

  2. Add an Application configuration in the Application Editor, as seen (or edit an existing one) select "Firebase."

  3. Enter the needed info and save with the "OK" button.

There will also be a server-side lua scripting component and a client-side component to getting notifications running, but those will be covered elsewhere in this documentation.

JSON Structure of Firebase Application Configuration

{
    "_id" : ObjectId("5cdb10c1e96c3c4f2bfe21f7"),
    "active" : true,
    "category" : "FIREBASE",
    "name" : "nameOfApplicationInFirebaseConsole",
    "parent" : {
        "$ref" : "application",
        "$id" : ObjectId("5cdb1088e96c3c4f2bfe1da7")
    },
    "serviceAccountCredentials" : "service account credentials from firebase console go here"
}
here
Firebase Configuration