Google Firebase

WARNING: In June 2024, legacy FCM APIs will be shut down. You must migrate to HTTP v1 before June. For instructions on migrating, see Migrating to Firebase HTTP v1 API.

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

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.
  4. From the General tab, copy the Project ID and save it in the text editor.
  5. Go to the Cloud Messaging tab.
  6. Scroll down to the Web Push certificates section.
  7. In the Web Push certificates sub-section, click Generate key pair.
  8. Save the keys in the text editor.
  9. Go to the Service accounts tab, select the JSON option and click Generate new private key.
    Result: A warning pop-up opens.
  10. On the pop-up, click Generate key.
    Result: The key is downloaded to your device.
  11. 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. Click Add connection.
  4. Switch the Enable integration toggle on.
  5. 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)
      Paste the contents of the whole .json file with the private key. If you haven’t copied it earlier in the process, you can find it in your Firebase account settings, on the Service accounts tab.
  6. 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 below). 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.
  7. Click Apply.

Migrating to Firebase HTTP v1 API


Use the following procedure to migrate from an older version of Firebase legacy FCM APIs (deprecated in June 2023, to be removed in June 2024) to HTTP 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.
  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 contents of the whole file with 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 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