Migrating to the Firebase Cloud Messaging API
Learn how to migrate from Google’s deprecated Cloud Messaging API to their fully-supported Firebase Cloud Messaging (FCM) API. For more information, see Google’s Firebase FAQ - 2023.
If this is your first time setting up the push integration for Android, see Standard Android push integration instead.
Step 1: Verify your Sender ID
First, open Braze, then select Settings > App Settings.
Under your Android app’s Push Notification Settings, check the number in the Firebase Cloud Messaging Sender ID field—you’ll compare this to the one in your Firebase project next.
Next, open Firebase Console, then select Settings > Project settings.
Select Cloud Messaging. Under Cloud Messaging API (Legacy), verify the Sender ID matches the one listed in your Braze dashboard.
Step 2: Create a service account
Next, create a new service account, so Braze can make authorized API calls when registering FCM tokens. In Google Cloud, go to Service Accounts, then choose your project. On the Service Accounts page, select Create Service Account.
Enter a service account name, ID, and description, then select Create and continue.
In the Role field, find and select Firebase Cloud Messaging API Admin from the list of roles. For more restrictive access, create a custom role with the
cloudmessaging.messages.create permission, then choose it from the list instead. When you’re finished, select Done.
Be sure to select Firebase Cloud Messaging API Admin, not Firebase Cloud Messaging Admin.
Step 3: Generate JSON credentials
Next, generate JSON credentials for your FCM service account. On Google Cloud IAM & Admin, go to Service Accounts, then choose your project. Locate the FCM service account you created earlier, then select Actions > Manage Keys.
Select Add Key > Create new key.
Choose JSON, then select Create.
Private keys could pose a security risk if compromised. Store your JSON credentials in a secure location for now—you’ll delete your key after you upload it to Braze.
Step 4: Upload your JSON credentials to Braze
In Braze, select Settings > App Settings.
Under Push Notification Settings, select Upload JSON File, then choose the file you generated earlier. When you’re finished, select Save.
Private keys could pose a security risk if compromised. Now that your key is uploaded to Braze, delete the file you generated previously.