Google Firebase

Google Firebase is used for notifications in mobile apps and websites.

WARNING:

The most important fields to be filled out are:

  • FCM - Project ID (Firebase V1)
  • FCM - private key JSON (Firebase V1)
    Soon, the rest of the fields in the Firebase configuration in Synerise will be deprecated.

Integrate Firebase with Synerise


  1. Go to Firebase Console website.
  2. If you don’t have a Firebase project:
    1. Click Create project.
    2. Follow the instructions on the interface.
    3. When your account is created, proceed to step 3.
  3. Go to Settings > Cloud Messaging.
  4. Copy the Server key and save it in a text editor.
  5. Copy the Sender ID and save it in the text editor.
  6. In the Cloud Messaging section, find the Web Push certificates tab.
  7. In the Web Push certificates tab, click Generate key pair.
  8. Save the keys in the text editor.
    Where to get Server key, Sender ID in Firebase, and Web Push certificates

    Firebase cloud messaging section
    Server key and Sender ID in Firebase Console settings section

  9. Go to the General section, copy the Project ID and save it in the text editor.
  10. Go to the Service accounts section, select the JSON option and click Generate new private key.
    Result: A warning pop-up opens.
  11. On the pop-up, click Generate key.
    Result: The key is downloaded to your device.
  12. Proceed to Enabling Firebase in Synerise.

Enabling Firebase in Synerise


  1. Go to Settings iconSettings > Apps & Services.
  2. In the list of integrations, click Firebase.
    Result: The Firebase settings expand.
  3. If you are using legacy Firebase API (older than HTTP v1), fill in the following fields:
    • FCM - Server Key
      If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Cloud Messaging tab.
    • FCM - Sender ID
      If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Cloud Messaging tab.
  4. If you are using Firebase HTTP v1 API, fill in the following fields:
    • FCM - Project ID (Firebase V1)
      If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the General tab.
    • FCM - private key JSON (Firebase V1)
      If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Service account tab.
  5. If you want to enable encryption, perform the following actions:
    1. Switch on the Push encryption toggle.
      Result: Push notifications are encrypted.
      WARNING:
      • You must implement decryption in your mobile applications. Client apps without decryption implemented receive no push messages at all. See the following articles:
      • You must provide the VAPID keys (see 5.b). If you do not provide the keys, web push messages are not sent at all.
    2. Fill in the following fields:
      • Public VAPID key
        If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Cloud Messaging > Web Push Certificates tab.
      • Private VAPID key
        If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Cloud Messaging > Web Push Certificates tab.
  6. Click Save.
  7. At the top of the section, switch on the toggle.
Firebase toggle
Enabling the Firebase integration

Migrating to the latest Firebase configuration


Use the following procedure to migrate from an older version of Firebase to Firebase V1.

  1. Go to Settings iconSettings > Apps & Services.
  2. On the list of integrations, find Firebase and click it.
    Result: A list of fields appears.
    The list of fields in the Firebase integration
    The list of fields in the Firebase integration
  3. In the FCM - Project ID (Firebase V1) field, enter the project ID.
    How to find the project ID

    1. Log in to Firebase Console.
      Main panel in Firebase Console
      Main panel in Firebase Console
    2. Go to Settings > Project settings > General.
    3. In the General tab, find the project ID.
      Project ID in Firebase Console
      Project ID is marked green in the image
    4. Copy the ID and paste it to the FCM - Project ID (Firebase V1) field in Synerise application.

  4. In the FCM - Private key JSON (Firebase V1) field, enter the private key.
    How to generate a private key file

    1. Log in to Firebase Console.
      Main panel in Firebase Console
      Main panel in Firebase Console
    2. Go to Settings > Project settings > Service accounts.
    3. In the Service accounts tab, click Generate new private key.
      Service accounts section in Firebase Console
      Service accounts section in Firebase Console
    4. Confirm by clicking Generate key.
    5. Store it securely on your device.
    6. Open the file your json file in text editor (notepad) or in any code editor.
    7. Copy the whole configuration.
    8. Paste it in the FCM - Private key JSON (Firebase V1) field in Synerise application.

    Important: After you finish, please make sure the configuration is correct by sending a test web push or mobile push campaign.
  5. Confirm by clicking Save.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.