Update docs for the FCM guide #986

Aviatorscode2 · 2025-10-16T17:10:54Z

Summary by CodeRabbit

Documentation
- Rewrote FCM integration guide into clear Step 1–4 setup with UI callouts and visuals
- Added Node.js and cURL examples for credential registration, token usage, topics, and web-push links
- Clarified per-integration token management and runtime override patterns
- Consolidated troubleshooting into accordion FAQ and updated navigation label for clarity

linear · 2025-10-16T17:10:58Z

netlify · 2025-10-16T17:11:01Z

❌ Deploy Preview for docs-novu failed. Why did it fail? →

Name	Link
🔨 Latest commit	`f268a37`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/68f12f3c9dbb450008d6afb5

coderabbitai · 2025-10-16T17:11:48Z

Walkthrough

Rewrites the FCM integration doc into a step-based guide (Steps 1–4), adds tabbed Node.js and cURL examples, documents per-integration token storage via integrationIdentifier, expands runtime overrides (android, apns, webPush, fcmOptions), adds topic and web-push link examples, and renames a navigation label in meta.json.

Changes

Cohort / File(s)	Summary
FCM documentation rewrite `content/docs/platform/integrations/push/(providers)/fcm.mdx`	Replaces old service-account JSON workflow with a 4-step Firebase → Novu setup; adds Novu UI callout, images, Tabs (Node.js / cURL) for credential updates and sending pushes; introduces `integrationIdentifier` for per-integration tokens; adds override schema (android, apns, webPush, fcmOptions), topic and web-push link examples, and accordion FAQ.
Navigation label update `content/docs/platform/meta.json`	Renames a navigation entry in the pages array from `"---Channels---"` to `"---Channels Provider Integration---"` (display label change only).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer
  participant Firebase as Firebase Console/API
  participant Novu as Novu (API/UI)
  participant Device as Client Device

  rect rgba(135,206,235,0.12)
    Dev->>Firebase: Create project & service account, download JSON (Step 1)
    Firebase-->>Dev: Service account JSON (contains required fields)
  end

  rect rgba(144,238,144,0.12)
    Dev->>Novu: Upload credentials / set integration (Step 2) \n(uses integrationIdentifier for per-integration tokens)
    Novu-->>Dev: Integration registered
  end

  rect rgba(255,228,181,0.12)
    Device->>Novu: Register device token (include integrationIdentifier) (Step 3)
    Novu-->>Device: Ack
  end

  rect rgba(221,160,221,0.12)
    Dev->>Novu: Send notification (Step 4) with overrides (android/apns/webPush/fcmOptions) or topic
    Novu->>Firebase: Deliver push (selects integration by integrationIdentifier)
    Firebase->>Device: Push notification
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

DianaHackmamba
jainpawan21
djabarovgeorge

Poem

🐰 Hopped through consoles, keys in paw,

Steps now tidy, clear, and raw.
Tabs and overrides snug and neat,
Tokens find their matching seat.
Docs refreshed — a carrot treat. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “Update docs for the FCM guide” succinctly and accurately describes the primary change—rewriting and enhancing the Firebase Cloud Messaging documentation—without unnecessary detail or unrelated noise. It clearly signals to reviewers that the pull request focuses on documentation updates for the FCM integration.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch MRK-1079

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

content/docs/platform/integrations/push/(providers)/fcm.mdx (1)
337-344: Use correct casing for fcmOptions.

The overrides API expects fcmOptions (camelCase). With fcm_options, the link override is ignored, so web push redirects break.

Apply this diff:
-            "webPush": {
-              "fcm_options": {
+            "webPush": {
+              "fcmOptions": {

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be6cc4c and e981e83.

⛔ Files ignored due to path filters (5)

public/images/channels-and-providers/push/confirmation-menu.png is excluded by !**/*.png
public/images/channels-and-providers/push/firebase-project-settings.png is excluded by !**/*.png
public/images/channels-and-providers/push/firebase-service-accounts.png is excluded by !**/*.png
public/images/channels-and-providers/push/integrationidentifier.png is excluded by !**/*.png
public/images/channels-and-providers/push/select-firebase-project.png is excluded by !**/*.png

📒 Files selected for processing (2)

content/docs/platform/integrations/push/(providers)/fcm.mdx (3 hunks)
content/docs/platform/meta.json (1 hunks)

🧰 Additional context used

🪛 LanguageTool

content/docs/platform/integrations/push/(providers)/fcm.mdx

[grammar] ~49-~49: There might be a mistake here.
Context: ...tion Store** page on the Novu dashboard. 3. Click Connect provider. 4. Under the...

(QB_NEW_EN)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Redirect rules - docs-novu
GitHub Check: Header rules - docs-novu
GitHub Check: Pages changed - docs-novu
GitHub Check: Build and Lint

content/docs/platform/integrations/push/(providers)/fcm.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e981e83 and f268a37.

📒 Files selected for processing (1)

content/docs/platform/integrations/push/(providers)/fcm.mdx (3 hunks)

coderabbitai · 2025-10-16T17:48:56Z

content/docs/platform/integrations/push/(providers)/fcm.mdx

+First, you need to get your project's service account credentials from the Firebase Console.
+
+1. Log in to the [Firebase console](https://console.firebase.google.com/).
+2. Created a new Firebase project or select an existing project.


⚠️ Potential issue | 🟡 Minor

Fix tense in instruction.

Please change “Created a new Firebase project…” to “Create a new Firebase project…” for correct imperative wording.

🤖 Prompt for AI Agents

In content/docs/platform/integrations/push/(providers)/fcm.mdx around line 18, the instruction uses past tense ("Created a new Firebase project..."); change it to the imperative present tense by replacing "Created" with "Create" so the step reads "Create a new Firebase project or select an existing project."

Update docs for the FCM guide

e981e83

coderabbitai bot reviewed Oct 16, 2025

View reviewed changes

content/docs/platform/integrations/push/(providers)/fcm.mdx Outdated Show resolved Hide resolved

Update content/docs/platform/integrations/push/(providers)/fcm.mdx

f268a37

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai bot reviewed Oct 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update docs for the FCM guide #986

Update docs for the FCM guide #986

Aviatorscode2 commented Oct 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

linear bot commented Oct 16, 2025

Uh oh!

netlify bot commented Oct 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 16, 2025 •

edited

Loading

Review ran into problems

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Oct 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Update docs for the FCM guide #986

Are you sure you want to change the base?

Update docs for the FCM guide #986

Conversation

Aviatorscode2 commented Oct 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

linear bot commented Oct 16, 2025

Uh oh!

netlify bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for docs-novu failed. Why did it fail? →

Uh oh!

coderabbitai bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Review ran into problems

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Aviatorscode2 commented Oct 16, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Oct 16, 2025 •

edited

Loading

coderabbitai bot commented Oct 16, 2025 •

edited

Loading