Google Firebase

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

WARNING:

By June 18, 2024, you must:

  1. Update from legacy FCM APIs to FCM HTTP v1 API (web push and mobile push).
  2. Add FCM Registration API settings even if you migrated to HTTP v1 API in the past (web push only).

To update, follow the instructions in “Updating to latest version of Firebase APIs”.

If you don’t update to HTTP v1 API, push messages will stop working entirely.
If you don’t enter the new Registration API settings, tokens can’t be refreshed or generated and deliverability will drop gradually.

The process doesn’t require any updates to how you use our Mobile and Web SDKs.

Important: From May 15, 2024, tokens which are inactive for 270 days become expired. More information is available in Google Firebase documentation.

Requirements


  • Enable FCM Registration API for your project.
  • If you want to use push encryption, you must implement decryption in your mobile applications. Client apps without decryption implemented will not receive push messages at all. See the following articles:

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 Project Settings.
    Result: You are redirected to the General tab.
  4. Copy the value of Project ID and save it in a text editor.
  5. If you want to use web push:
    1. Copy the value of Web API key and save it in a text editor.
      Project Settings in Firebase
      Project Settings in Firebase
    2. Scroll down the page to the Your apps section.
    3. Download the Firebase config file or object according to the instructions in the Google Firebase documentation.
      The configuration file in Firebase
      The configuration file in Firebase
    4. From the Your apps section, retrieve the value of App ID and save it in a text editor.
  6. Go to the Cloud Messaging tab.
    1. Copy the value of Sender ID and save it in a text editor.
    2. If you want to enable web push encryption, retrieve the VAPID keys:
      1. Scroll down to Web configuration.
      2. Create or retrieve a key pair. To access the private key, you may need the Owner role in the Firebase project.
      3. Save the key pair in a text editor.
  7. Go to the Service accounts tab.
    1. Click Generate new private key.
    2. Confirm with Generate key and wait a few seconds.
    3. Save the key.
      Depending on your browser and settings, the key may open in a window or be saved as a JSON file.
      Save the entire contents (all properties).
  8. Proceed to Enabling Firebase in Synerise.

Enabling Firebase in Synerise


  1. Go to Settings iconSettings > Apps & Services.
  2. In the list of integrations, next to Firebase, click Show.
    Result: A list of existing Firebase connections opens.
  3. Click Add connection.
  4. Under Connection with Firebase, switch the toggle on.
  5. In the Connection name field, enter the name of the connection.
    It will be available only on the list of Firebase connections in Synerise.
  6. Select the channel for which you are enabling integration:
  1. Fill in the following fields, using the data you retrieved in Integrate Firebase with Synerise:
    • Sender ID
      This field is required.
    • Project ID
      This is required to send notifications. If you haven’t copied it earlier in the process, you can find it in your Firebase Console project settings inside the General tab.
    • Private key
      Private key is required to create authentication tokens. In this field , you must paste the entire JSON file you downloaded when integrating Firebase with Synerise.
  2. If you want to enable encryption, perform the following actions:
    1. Ensure that decryption is implemented in your mobile application.
    2. Switch on the Push encryption toggle.
      Result: Push notifications are encrypted.
  3. Click Apply.

Updating to latest version of Firebase APIs

You must update the connection settings with new fields required by Firebase API updates.

  1. Ensure that FCM Registration API is enabled for your project.
  2. Go to Settings iconSettings > Apps & Services.
  3. In the list of integrations, next to Firebase, click Show.
    Result: A list of existing Firebase connections opens.
  4. On the connection you want to update, click Three dots icon > Edit.
  5. Select your migration path:

Firebase API v1 already enabled

Follow the instructions depending on the channels you use:

Firebase API v1 is already enabled. You don’t need to do anything.

Full update required

Follow the instructions depending on the push channels you use:

You must enter the Firebase API v1 parameters.

  1. Go to the Firebase Console website.
  2. Go to Project settings.
  3. From the General tab, copy Project ID into a text editor.
  4. Go to the Service accounts tab.
    1. Click Generate new private key.
    2. Confirm with Generate key and wait a few seconds.
    3. Save the key.
      Depending on your browser and settings, the key may open in a window or be saved as a JSON file.
      Save the entire contents (all properties).
  5. Return to integration settings in Synerise.
  6. Paste the project ID into the Project ID field.
  7. Paste the private key (entire JSON) into the Private key field.
  8. Click Apply.
😕

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.

Close modal icon Placeholder alt for modal to satisfy link checker