FCM Push Integration with Novu

This guide explains the process of configuring and using FCM with Novu, from getting your credentials to sending your first notification.

Novu uses FCM version V1

Step 1: Generate your service account key from Firebase

Get your project’s service account credentials from the Firebase Console.

Log in to the Firebase console.
Create a new Firebase project or select an existing project.
Click the gear icon ⚙️ next to Project Overview.
Select Project settings.
Click the Service accounts tab.
Click the Generate new private key button. A confirmation menu appears.
Click Generate key to download a JSON file containing your credentials.

Open the downloaded JSON file and ensure it contains these fields:

{
  "type": "service_account",
  "project_id": "PROJECT_ID",
  "private_key_id": "PRIVATE_KEY_ID",
  "private_key": "PRIVATE_KEY",
  "client_email": "FIREBASE_ADMIN_SDK_EMAIL",
  "client_id": "CLIENT_ID",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "CLIENT_X509_CERT_URL"
}

Step 2: Connect FCM to Novu

Add the credentials to your FCM integration in the Novu dashboard.

Log in to the Novu dashboard.
Navigate to the Integration Store.
Click Connect provider.
Click the Push tab, then select Firebase Cloud Messaging (FCM).
Open the JSON file you downloaded from Firebase in Step 1.
Copy the entire content of the JSON file and paste it into the Service Account field in the FCM integration modal.
Click Create Integration to save the integration.

Step 3: Register a subscriber’s device token

Before Novu can send a push notification to your subscriber, you must associate their device’s unique push token with their Novu subscriber profile. You can do this by making an API call to update the subscriber’s credentials.

import { Novu } from '@novu/api';
import { ChatOrPushProviderEnum } from "@novu/api/models/components";

const novu = new Novu({ secretKey: "<NOVU_SECRET_KEY>" });

await novu.subscribers.credentials.update(
  {
    providerId: ChatOrPushProviderEnum.Fcm,
    integrationIdentifier: "string",
    credentials: { deviceTokens: ["token1", "token2"] },
  },
  "subscriberId"
);

import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.subscribers.credentials.update(
        subscriber_id="subscriberId",
        update_subscriber_channel_request_dto={
            "provider_id": novu_py.ChatOrPushProviderEnum.FCM,
            "credentials": {"deviceTokens": ["token1", "token2"]},
            "integration_identifier": "string",
        },
    )

import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Subscribers.Credentials.Update(context.Background(), "subscriberId", components.UpdateSubscriberChannelRequestDto{
    ProviderID: components.ChatOrPushProviderEnumFcm,
        IntegrationIdentifier: novugo.String("string"),
    Credentials: components.ChannelCredentials{
        DeviceTokens: []string{"token1", "token2"},
    },
}, nil)

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()->setSecurity('<NOVU_SECRET_KEY>')->build();

$sdk->subscribersCredentials->update(
    subscriberId: 'subscriberId',
    updateSubscriberChannelRequestDto: new Components\UpdateSubscriberChannelRequestDto(
        providerId: Components\ChatOrPushProviderEnum::Fcm,
        integrationIdentifier: 'string',
        credentials: new Components\ChannelCredentials(
            deviceTokens: ['token1', 'token2'],
        ),
    ),
);

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<NOVU_SECRET_KEY>");

await sdk.Subscribers.Credentials.UpdateAsync(
    subscriberId: "subscriberId",
    updateSubscriberChannelRequestDto: new UpdateSubscriberChannelRequestDto() {
        ProviderId = ChatOrPushProviderEnum.Fcm,
        IntegrationIdentifier = "string",
        Credentials = new ChannelCredentials() {
            DeviceTokens = new List<string> { "token1", "token2" },
        },
    });

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.List;

Novu novu = Novu.builder().secretKey("<NOVU_SECRET_KEY>").build();

novu.subscribers().credentials().update()
    .subscriberId("subscriberId")
    .body(UpdateSubscriberChannelRequestDto.builder()
        .providerId(ChatOrPushProviderEnum.FCM)
            .integrationIdentifier("string")
        .credentials(ChannelCredentials.builder()
            .deviceTokens(List.of("token1", "token2"))
            .build())
        .build())
    .call();

curl -L -X PUT 'https://api.novu.co/v1/subscribers/<SUBSCRIBER_ID>/credentials' \
-H 'Content-Type: application/json' \
-H 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
  "providerId": "fcm",
  "credentials": {
    "deviceTokens": [
      "token1",
      "token2"
    ]
  },
  "integrationIdentifier": "string"
}'

Remove device tokens

When a subscriber logs out or uninstalls your app, remove their FCM device token so notifications are not delivered to the wrong user. See Remove device tokens on the Push channel guide for removing a specific token, clearing all tokens for a provider, and automatic stale-token cleanup for FCM.

Step 4: Send a notification

Now you’re ready to send a push notification. You can trigger a notification to a subscriber who has a registered device token.

import { Novu } from '@novu/api';

const novu = new Novu({ secretKey: "<NOVU_SECRET_KEY>" });

await novu.trigger({
  workflowId: "workflowId",
  to: { subscriberId: "subscriberId", },
  payload: {
    "key": "value"
},
  overrides: {
    "providers": {
        "fcm": {
            "topic": "topic-123"
        }
    }
},
});

import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflowId",
        to={"subscriber_id": "subscriberId"},
        payload={
        "key": "value"
},
        overrides={
        "providers": {
                "fcm": {
                        "topic": "topic-123"
                }
        }
},
    ))

import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflowId",
    To: components.CreateToSubscriberPayloadDto(components.SubscriberPayloadDto{
        SubscriberID: "subscriberId",
    }),
    Payload: map[string]any{
        "key": "value",
    },
    Overrides: map[string]any{
        "providers": map[string]any{
            "fcm": map[string]any{
                "topic": "topic-123",
            },
        },
    },
}, nil)

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()->setSecurity('<NOVU_SECRET_KEY>')->build();

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflowId',
        to: new Components\SubscriberPayloadDto(subscriberId: 'subscriberId'),
        payload: ['key' => 'value'],
        overrides: [
            'providers' => [
                'fcm' => [
                    'topic' => 'topic-123',
                ],
            ],
        ],
    ),
);

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<NOVU_SECRET_KEY>");

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflowId",
    To = To.CreateSubscriberPayloadDto(new SubscriberPayloadDto() { SubscriberId = "subscriberId" }),
    Payload = new Dictionary<string, object>() {
        { "key", "value" },
    },
    Overrides = new Overrides() {
        Providers = new Dictionary<string, Dictionary<string, object>>() {
            { "fcm", new Dictionary<string, object>() {
                { "topic", "topic-123" },
            } },
        },
    },
});

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.Map;

Novu novu = Novu.builder().secretKey("<NOVU_SECRET_KEY>").build();

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflowId")
        .to(To2.of(SubscriberPayloadDto.builder().subscriberId("subscriberId").build()))
        .payload(Map.of("key", "value"))
        .overrides(TriggerEventRequestDtoOverrides.builder()
            .additionalProperties(Map.of("providers", Map.of("fcm", Map.of("topic", "topic-123"))))
            .build())
        .build())
    .call();

curl --location 'https://api.novu.co/v1/events/trigger' \
--header 'Content-Type: application/json' \
--header 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflowId",
    "to": [
        "subscriberId"
    ],
    "payload": {
        "key": "value"
    },
    "overrides": {
        "providers": {
            "fcm": {
                "topic": "topic-123"
            }
        }
    }
}'

Configure FCM overrides

Save an FCM override on the Push step when you need Firebase HTTP v1 Message fields beyond the step subject and body — for example data, platform payloads (android, apns, webpush), fcmOptions, or routing (token, tokens, topic, condition). The override is stored on the step, so it is versioned and promoted with the workflow, and every trigger sends it without changing your trigger call.

Provider content overrides in the workflow editor are rolling out gradually and may not be available on your Push step yet. Overrides passed at trigger time work regardless. See provider content overrides.

FCM overrides are validated against the FCM HTTP v1 Message shape, plus Novu’s multicast tokens key. The editor autocompletes supported field names, validates the JSON, and flags unsupported fields. Supported top-level keys: notification, data, android, apns, webpush, fcmOptions, token, tokens, topic, and condition. token, topic, and condition match the HTTP v1 target fields; tokens is Novu’s multicast alias (Firebase Admin MulticastMessage). Step content overrides use the HTTP v1 field names (including webpush); trigger examples elsewhere on this page may still show Novu’s webPush alias. notification.body is the primary content key. If your override omits it, Novu uses the rendered Push step body.

Routing with content overrides

You may set exactly one of token, tokens, topic, or condition in a step content override. These fields support Liquid, for example topic: "org-{{subscriber.data.orgId}}". When you omit routing keys, Novu fills device tokens from the subscriber’s credentials for normal deliveries.

A static topic or condition in a step content override is evaluated once per matching subscriber. If a trigger targets N subscribers, Novu sends N topic (or condition) broadcasts. Prefer a trigger-time topic when you want a single broadcast for the whole trigger, or use subscriber-specific Liquid so each subscriber resolves a distinct target.

Trigger overrides for these routing keys still work. When the same routing field is set both on the step and at trigger time, the trigger value wins. See provider override scopes.

Routing with `_passthrough`

Routing keys also take effect inside _passthrough.body, which is merged last and therefore wins over the same field set on the step or at trigger time. You own the destination when you set these fields. Because FCM addresses one destination per message, a routing key in _passthrough.body replaces the whole set rather than adding to it. In the example below the message goes to news_updates only — the tokens array is dropped, not sent alongside:

{
  "overrides": {
    "providers": {
      "fcm": {
        "tokens": ["token1", "token2"],
        "_passthrough": {
          "body": {
            "topic": "news_updates"
          }
        }
      }
    }
  }
}

Novu ignores a passthrough routing value it cannot address — anything that is not a non-empty string, or for tokens an array of non-empty strings — and falls back to the routing set below it. Unlike the schematized keys, _passthrough is not validated, so a typo or a wrong type is silently ignored instead of flagged. The per-subscriber fan-out warning above applies to a topic or condition set in _passthrough too. See the FCM HTTP v1 Message reference for the full field list.

Web push with relative links

Suppose you’re using the Firebase (FCM) provider to send push notifications to web browsers via Novu and want users to be returned to the website after clicking the notification. In that case, you must use the link property with a relative URL.

import { Novu } from '@novu/api';

const novu = new Novu({ secretKey: "<NOVU_SECRET_KEY>" });

await novu.trigger({
  workflowId: "workflowId",
  to: { subscriberId: "subscriberId", },
  payload: {
    "key": "value"
},
  overrides: {
    "providers": {
        "fcm": {
            "webPush": {
                "fcmOptions": {
                    "link": "/foo"
                }
            }
        }
    }
},
});

import os
import novu_py
from novu_py import Novu

with Novu(secret_key=os.getenv("NOVU_SECRET_KEY", "")) as novu:
    novu.trigger(trigger_event_request_dto=novu_py.TriggerEventRequestDto(
        workflow_id="workflowId",
        to={"subscriber_id": "subscriberId"},
        payload={
        "key": "value"
},
        overrides={
        "providers": {
                "fcm": {
                        "webPush": {
                                "fcmOptions": {
                                        "link": "/foo"
                                }
                        }
                }
        }
},
    ))

import (
    "context"
    "os"

    novugo "github.com/novuhq/novu-go"
    "github.com/novuhq/novu-go/models/components"
)

s := novugo.New(novugo.WithSecurity(os.Getenv("NOVU_SECRET_KEY")))

res, err := s.Trigger(context.Background(), components.TriggerEventRequestDto{
    WorkflowID: "workflowId",
    To: components.CreateToSubscriberPayloadDto(components.SubscriberPayloadDto{
        SubscriberID: "subscriberId",
    }),
    Payload: map[string]any{
        "key": "value",
    },
    Overrides: map[string]any{
        "providers": map[string]any{
            "fcm": map[string]any{
                "webPush": map[string]any{
                    "fcmOptions": map[string]any{
                        "link": "/foo",
                    },
                },
            },
        },
    },
}, nil)

use novu;
use novu\Models\Components;

$sdk = novu\Novu::builder()->setSecurity('<NOVU_SECRET_KEY>')->build();

$sdk->trigger(
    triggerEventRequestDto: new Components\TriggerEventRequestDto(
        workflowId: 'workflowId',
        to: new Components\SubscriberPayloadDto(subscriberId: 'subscriberId'),
        payload: ['key' => 'value'],
        overrides: [
            'providers' => [
                'fcm' => [
                    'webPush' => [
                        'fcmOptions' => [
                            'link' => '/foo',
                        ],
                    ],
                ],
            ],
        ],
    ),
);

using Novu;
using Novu.Models.Components;
using System.Collections.Generic;

var sdk = new NovuSDK(secretKey: "<NOVU_SECRET_KEY>");

await sdk.TriggerAsync(triggerEventRequestDto: new TriggerEventRequestDto() {
    WorkflowId = "workflowId",
    To = To.CreateSubscriberPayloadDto(new SubscriberPayloadDto() { SubscriberId = "subscriberId" }),
    Payload = new Dictionary<string, object>() {
        { "key", "value" },
    },
    Overrides = new Overrides() {
        Providers = new Dictionary<string, Dictionary<string, object>>() {
            { "fcm", new Dictionary<string, object>() {
                { "webPush", new Dictionary<string, object>() {
                    { "fcmOptions", new Dictionary<string, object>() {
                        { "link", "/foo" },
                    } },
                } },
            } },
        },
    },
});

import co.novu.Novu;
import co.novu.models.components.*;
import java.util.Map;

Novu novu = Novu.builder().secretKey("<NOVU_SECRET_KEY>").build();

novu.trigger()
    .body(TriggerEventRequestDto.builder()
        .workflowId("workflowId")
        .to(To2.of(SubscriberPayloadDto.builder().subscriberId("subscriberId").build()))
        .payload(Map.of("key", "value"))
        .overrides(TriggerEventRequestDtoOverrides.builder()
            .additionalProperties(Map.of("providers", Map.of("fcm", Map.of(
                "webPush", Map.of("fcmOptions", Map.of("link", "/foo"))))))
            .build())
        .build())
    .call();

curl --location 'https://api.novu.co/v1/events/trigger' \
--header 'Content-Type: application/json' \
--header 'Authorization: ApiKey <NOVU_SECRET_KEY>' \
-d '{
    "name": "workflowId",
    "to": [
        "subscriberId"
    ],
    "payload": {
        "key": "value"
    },
    "overrides": {
        "providers": {
            "fcm": {
                "webPush": {
                    "fcmOptions": {
                        "link": "/foo"
                    }
                }
            }
        }
    }
}'

Frequently asked questions

FCM cost

As per Firebase pricing, Cloud Messaging product is free to use. If other Firebase products are used, then the cost are charged per the product.

The registration token is not a valid FCM registration token

You might come across an error such as: Sending message failed due to "The registration token is not a valid FCM registration token". This error happens because of an invalid or stale token. The fix for this is:

Remove the old tokens.
Generate a new token.
Save the new token into user subscribers.

FCM notifications sent successfully with no error but push notification is not received in device

Try to generate a new token after clearing device cache and retry with this fresh token.

Sending message failed due to 'Requested entity was not found'

This error occurs when your token is no longer valid. To fix this, generate a new token and use it.

Subscriber does not have a configured channel error

This error occurs if the FCM integration is active, but the subscriber is missing from the FCM credentials (deviceTokens). The credentials (deviceTokens) for the subscriber needs to be set.

How to send desktop notifications using FCM

Desktop notifications for websites can be sent using FCM webpush.

Getting Started

Integrate <Inbox />

Integrate <Subscription />

Build a Workflow

Integrate Channels Providers

SDKs

Developer

Account

Build with AI

Additional Resources

FCM Push Integration with Novu

Step 1: Generate your service account key from Firebase

Step 2: Connect FCM to Novu

Step 3: Register a subscriber’s device token

Remove device tokens

Step 4: Send a notification

Configure FCM overrides

Routing with content overrides

Routing with `_passthrough`

Web push with relative links

Frequently asked questions

​Step 1: Generate your service account key from Firebase

​Step 2: Connect FCM to Novu

​Step 3: Register a subscriber’s device token

​Remove device tokens

​Step 4: Send a notification

​Configure FCM overrides

​Routing with content overrides

​Routing with _passthrough

​Web push with relative links

​Frequently asked questions

Step 1: Generate your service account key from Firebase

Step 2: Connect FCM to Novu

Step 3: Register a subscriber’s device token

Remove device tokens

Step 4: Send a notification

Configure FCM overrides

Routing with content overrides

Routing with `_passthrough`

Web push with relative links

Frequently asked questions