Skip to main content

Firebase upgrade to HTTP v1 API

Updated

Firebase upgrade to HTTP v1 API - Bloomreach Engagement approach

Due to Google deprecating and removing the FCM legacy API in June 2024, Bloomreach Engagement is moving to the new Firebase HTTP v1 API.

In order to keep using Firebase to send push notifications to Android devices, clients must use a new Firebase Cloud Messaging integration from the Data & Assets > Integrations section.

This integration will use a different authentication mechanism using Private Keys obtained via Service Accounts on Google Cloud.

Follow the steps below to add the new integration:

  1. Create a service account. To create a new service account in Google Cloud, go to
    Service Accounts, then choose your project. On the Service Accounts page, select
    Create Service Account. It is possible to use roles to define more granular access.
  2. Generate new Private Key. For that you would need to Locate the FCM service account you created earlier, then select Actions > Manage Keys. Select Select Add Key > Create new key. The JSON key file can be downloaded then.

  3. Insert this key into the new Firebase Cloud Messaging integration settings page in
    Bloomreach Engagement.

Once this is set up and the new Firebase Cloud Messaging integration is set in Project Settings > Channels > Push notifications > Firebase Cloud Messaging integration the push notifications for Android devices will start to be delivered using the new API.

Considerations:

  1. The old Firebase integration will be deprecated. Sending push notifications via this integration will stop working after June 2024.
  2. There shouldn’t be any disruption of service when switching the integrations.
    NOTE: When switching integrations don’t disable the old integration immediately, wait half an hour to make sure that running scenarios can finish sending the push notifications via the old integration.

Frequently Asked Questions:

  1. How will the changes in push notification payload be handled for clients who have added the new Firebase integration, and for those who haven’t?
    Bloomreach Engagement handles the changes in the payload, because clients provide only the Data (key to value structure) which is part of the payload and that doesn't change.
  2. How will sending push notifications be implemented on the backend with the new integration?
    What will change with the Firebase HTTP v1 API? Performance-wise there won’t be any change, as the previous implementation already fired 1 request per customer - and this doesn't change with the new implementation.
  3. How will the Firebase API update affect Mobile SDKs?
    Will there be a new SDK release that will require app release on the client side? No, there are no changes to Mobile SDK and therefore no need to update Mobile SDKs.

Related articles