/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    FCM migration guide

    Copy link

    Effective June 20, 2024, Firebase will be deprecating the FCM legacy API. To ensure uninterrupted push notification functionality, it is recommended that you migrate to the new FCM HTTP v1 API as soon as possible. If you have any questions or concerns, contact us on Sendbird Dashboard.

    Note: No additional changes need to be made on the Sendbird Chat SDK.


    Migrate from legacy API to HTTP v1

    Copy link

    This migration guide will help you seamlessly transition from FCM legacy API to HTTP v1.

    Step 1 Generate a new private key on Firebase Console

    Copy link

    ![Image|Firebase console screen to generate a new private key.]

    You need to generate a private key file in JSON format.

    1. Open the Firebase console and click on your project.
    2. Go to Project settings > Service Accounts.
    3. Click on Generate new private key and confirm by clicking Generate key.
    4. Securely store the JSON file containing the private key that will be downloaded.

    Step 2 Register service account key on Sendbird Dashboard

    Copy link

    If you are adding a service account key to an existing FCM push configuration, follow these steps:

    1. On Sendbird Dashboard, go to Application > Settings > Notifications > Push notifications.

    2. Scroll down to the FCM section and find the configuration where you want to register the HTTP v1 key. Click on Add+.

    1. Under Service account key (HTTP v1), upload the JSON file containing the key that was downloaded in step 1.

    1. Once the file is successfully uploaded, click Save to save the credential.

    Step 2-1 Register new FCM push configuration

    Copy link

    If you are registering a completely new FCM push notification, follow these steps:

    1. On Sendbird Dashboard, Go to Application > Settings > Notifications > Push notifications.

    2. Scroll down to the FCM section and click on Add credential.

    3. Under Service account key (HTTP v1), upload the JSON file containing the key what was downloaded in step 1.

    1. Once the file is successfully uploaded, click Add to save the credential.

    Step 3 Test your push notifications

    Copy link

    After registering your service account key, you can test whether the push notification services work properly. In Settings > Notifications > Push notification credentials on your Sendbird Dashboard, each credential has a Send button that allows you to send a test message. For further details, refer to the push notifications tester page.


    By following these steps, you will successfully migrate your FCM configuration from the Legacy API to the HTTP v1 API. This will ensure that your push notifications continue to operate seamlessly.