Update content for Pusher beams provider guide

[Aviatorscode2]

Summary by CodeRabbit

• Documentation
  • Restructured and expanded Pusher Beams integration guide with comprehensive step-by-step setup instructions for credentials retrieval and provider connection.
  • Added new subsections, updated API references, and enhanced code examples to provide clearer, more guided integration instructions.

[linear]

MRK-1095 Pusher Beams

[netlify]

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

Name	Link
🔨 Latest commit	9d1c0b8
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/68fa67a14b03ac0008298cbc

[coderabbitai]

Walkthrough

The Pusher Beams integration documentation has been substantially rewritten with expanded content, restructured sections, improved step-by-step setup guidance, new subsections, updated code examples, and enhanced API references. The import line was replaced with a static HTML anchor.

Changes

Cohort / File(s)	Summary
Documentation Restructuring content/docs/platform/integrations/push/(providers)/pusher-beams.mdx	Substantially rewrites MDX content with expanded step-by-step setup flow including credentials retrieval and provider connection, migrates and renames sections, introduces new subsections and images, updates API references and code examples, replaces import with static HTML anchor, and augments narrative structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Documentation rewrites are generally low-complexity reviews when focusing on content clarity, accuracy, and consistency rather than logic. This change maintains existing code blocks while restructuring and expanding narrative content and setup guidance.

Poem

A rabbit hops through docs so bright,
Pusher Beams now setup right,
Step by step the path unfolds,
Better guides that truth upholds,
🐰✨📚

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "Update content for Pusher beams provider guide" directly and accurately summarizes the main change in the changeset. The raw summary confirms that the primary modification is a substantial rewrite and restructuring of the Pusher Beams integration documentation file (pusher-beams.mdx), which is exactly what the title conveys. The title is specific and clear—it identifies both the provider (Pusher beams) and the action (content update), allowing a teammate scanning the history to immediately understand the primary change. The title is appropriately concise and avoids vague terminology.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

content/docs/platform/integrations/push/(providers)/pusher-beams.mdx (2)

111-112: Clarify payload restrictions for external SDK users.

The inline comment about the "pusher" key restriction in the notification payload is valuable but somewhat buried. Consider making this a note or callout block to ensure users don't miss this important constraint when structuring their custom data.

---

49-88: Example device token formats should be normalized for clarity.

The code is correct: ChatOrPushProviderEnum.PusherBeams properly maps to "pusher-beams" in both examples. However, the device token examples are inconsistent—Node.js uses generic ["token1", "token2", "token3"] while cURL shows a single token labeled ['userId-from-pusher-beams']. To improve clarity, either use consistent generic placeholders across both examples or add inline comments explaining what actual tokens should replace these placeholders.

📜 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 9d1c0b8.

⛔ Files ignored due to path filters (3)

• public/images/channels-and-providers/push/pusher-beams/create-instance.png is excluded by !**/*.png
• public/images/channels-and-providers/push/pusher-beams/instance-credentials.png is excluded by !**/*.png
• public/images/channels-and-providers/push/pusher-beams/pusher-beams-integration.png is excluded by !**/*.png

📒 Files selected for processing (1)

• content/docs/platform/integrations/push/(providers)/pusher-beams.mdx (3 hunks)

⏰ 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

🔇 Additional comments (4)

content/docs/platform/integrations/push/(providers)/pusher-beams.mdx (4)

6-8: Good documentation structure with helpful setup guidance.

The introduction clearly frames the guide scope, uses proper external link security attributes (target="_blank" rel="noopener noreferrer"), and establishes what readers will accomplish. The section headings and flow from configuration → usage is well-organized.

---

6-6: All external links use proper security attributes.

The documentation consistently uses target="_blank" rel="noopener noreferrer" for external links (Pusher SDK setup, getUserId method, dashboard links). This follows security best practices.

Also applies to: 43-43, 45-45

---

18-23: All image assets and cross-reference links are valid—no action required.

Both referenced images exist at the correct paths, and the anchor link #step-2-connect-pusher-beams-to-novu correctly matches the heading format on line 25.

---

47-47: All internal documentation links are valid and accessible.

The API reference link at line 47 (/api-reference/subscribers/update-provider-credentials) correctly points to an existing file, and the internal anchor at line 22 (#step-2-connect-pusher-beams-to-novu) maps to the "Step 2: Connect Pusher Beams to Novu" heading in the document. No broken or missing links detected.