# Firebase Cloud Messaging

This page shows you how to receive Stream Chat push notifications using [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging).

## Configuring Notifications on the Stream Dashboard

To be able to receive notifications from Stream, you need to provide your Firebase credentials to Stream.

Go to the [Firebase Console](https://console.firebase.google.com/), and select the project your app belongs to.

<admonition type="info">

If you don't have a Firebase project yet, you'll have to create a new one.

</admonition>

Click on the gear icon next to **Project Overview** and navigate to **Project settings**:

![Opening Firebase's Project settings](@shared/assets/notifications_firebase_setup_step_1.jpeg)

Navigate to the **Service Accounts** tab. Under **Firebase Admin SDK** section, click on **Generate new private key** button that will generate a _json_ file with the **Firebase Credentials**.

![Generate your Firebase Credentials json file](@shared/assets/notifications_firebase_setup_step_2.png)

Open the [Stream Dashboard](https://dashboard.getstream.io/). Navigate to the Chat **Overview** page for your app.

![Navigating to the Chat Overview page on the Stream Dashboard](@shared/assets/notifications_firebase_setup_step_3.png)

Scroll down and enable the **Firebase** switch. Paste the content of the _json_ file with the **Firebase Credentials** that you downloaded during the previous step, and click **Save** to confirm your changes.

![Setting up your Firebase Credentials on the Stream Dashboard](@shared/assets/notifications_firebase_setup_step_4.png)

That's the server-side setup done. You can now receive push notifications from Stream Chat on the client side. To register devices and process these notifications, follow the steps below.


## Receiving Notifications in the Client

We provide an artifact with all the implementation needed to work with **Firebase**. To use it follow the next steps:

Start by [adding Firebase to your Android project](https://firebase.google.com/docs/cloud-messaging/android/client). You only need to set up the FCM dependencies and add a _google-services.json_ file to your project source directory.

Next, add the Stream Firebase push provider artifact to your app's `build.gradle` file:

```groovy
dependencies {
    implementation "io.getstream:stream-android-push-firebase:$stream_android_push_firebase_version"
}
```

<admonition type="warning">

Please note that this library follows a separate versioning scheme from the Stream Chat SDK. To use it correctly, make sure to check the latest version of `stream_android_push_firebase` on its own [GitHub repository](https://github.com/GetStream/stream-android-push/releases).

</admonition>

Finally, add the `FirebasePushDeviceGenerator` to your `NotificationConfig` and pass it into the `ChatClient.Builder` when you initialize the SDK:

<tabs>

<tabs-item value="kotlin" label="Kotlin">

```kotlin {2,5}
val notificationConfig = NotificationConfig(
    pushDeviceGenerators = listOf(FirebasePushDeviceGenerator(providerName = "providerName"))
)
ChatClient.Builder("apiKey", context)
    .notifications(notificationConfig)
    .build()
```

</tabs-item>

<tabs-item value="java" label="Java">

```java
boolean pushNotificationEnabled = true;
    List<PushDeviceGenerator> pushDeviceGeneratorList = Collections.singletonList(
            new FirebasePushDeviceGenerator(
                    "providerName"
            )
    );
    NotificationConfig notificationConfig = new NotificationConfig(true, pushDeviceGeneratorList);
    new ChatClient.Builder("apiKey", context)
            .notifications(notificationConfig)
            .build();
```

</tabs-item>

</tabs>

<admonition type="warning">

Make sure that _ChatClient_ is always initialized before handling push notifications. We highly recommend initializing it in the `Application` class.

</admonition>

That's it. You can now receive push notifications from Stream via Firebase.

### Using a Custom Firebase Messaging Service

The Stream Firebase push provider artifact includes an implementation of `FirebaseMessagingService` that will send new Firebase tokens and incoming push messages to the Stream SDK.

If you're also using Firebase notifications for other things in your app, you can use your own custom service instead. This should make the following calls to the `FirebaseMessagingDelegate` class:

<tabs>

<tabs-item value="kotlin" label="Kotlin">

```kotlin {6,14}
class CustomFirebaseMessagingService : FirebaseMessagingService() {

    override fun onNewToken(token: String) {
        // Update device's token on Stream backend
        try {
            FirebaseMessagingDelegate.registerFirebaseToken(token, "providerName")
        } catch (exception: IllegalStateException) {
            // ChatClient was not initialized
        }
    }

    override fun onMessageReceived(message: RemoteMessage) {
        try {
            if (FirebaseMessagingDelegate.handleRemoteMessage(message)) {
                // RemoteMessage was from Stream and it is already processed
            } else {
                // RemoteMessage wasn't sent from Stream and it needs to be handled by you
            }
        } catch (exception: IllegalStateException) {
            // ChatClient was not initialized
        }
    }
}
```

</tabs-item>

<tabs-item value="java" label="Java">

```java
public final class CustomFirebaseMessagingService extends FirebaseMessagingService {

    @Override
    public void onNewToken(@NonNull String token) {
        // Update device's token on Stream backend
        try {
            FirebaseMessagingDelegate.registerFirebaseToken(token, "providerName");
        } catch (IllegalStateException exception) {
            // ChatClient was not initialized
        }
    }

    @Override
    public void onMessageReceived(@NonNull RemoteMessage message) {
        try {
            if (FirebaseMessagingDelegate.handleRemoteMessage(message)) {
                // RemoteMessage was from Stream and it is already processed
            } else {
                // RemoteMessage wasn't sent from Stream and it needs to be handled by you
            }
        } catch (IllegalStateException exception) {
            // ChatClient was not initialized
        }
    }
}
```

</tabs-item>

</tabs>

<admonition type="note">

Make sure that your custom service has an [`<intent-filter>` priority](https://developer.android.com/guide/topics/manifest/intent-filter-element#priority) higher than `-1` to override our default service. (This priority is `0` by default.)

</admonition>

### Push Notification Payload

Push notifications are delivered as data payloads that the SDK can use to convert into the same data types that are received when working with the APIs.

When a message received by the Chat API, according to the delivery rules, it kicks a job that sends a regular data message (as below) to configured push providers on your app. According to the battery and the online status of the device, push providers deliver this payload to the actual devices. When a device receives the payload, it's passed to the SDK which connects to Chat API to receive regular message and channel records and unmarshals them into in-memory objects and gives control to you by passing these objects. At this point, your application can use these objects to generate any push notification to be shown to the user.

This is the main payload which will be sent to each configured provider:

```javascript
{
  "sender": "stream.chat",
  "type": "message.new",
  "version": "v2",
  "message_id": "d152f6c1-8c8c-476d-bfd6-59c15c20548a",
  "id": "d152f6c1-8c8c-476d-bfd6-59c15c20548a",
  "channel_type": "messaging",
  "channel_id": "company-chat",
  "cid": "messaging:company-chat",
  "receiver_id": "company-chat-user1"
}
```



---

This page was last updated at 2026-04-17T17:33:31.832Z.

For the most recent version of this documentation, visit [https://getstream.io/chat/docs/sdk/android/v6/client/guides/push-notifications/push-providers/firebase/](https://getstream.io/chat/docs/sdk/android/v6/client/guides/push-notifications/push-providers/firebase/).