Update content on Pushpad guide #992

Aviatorscode2 · 2025-10-23T19:17:41Z

Summary by CodeRabbit

Documentation
- Expanded Pushpad integration guide into a step-by-step walkthrough for end-to-end setup.
- Added clear instructions for obtaining and entering Pushpad credentials in the dashboard.
- Included subscriber registration and credential update procedures with practical examples (TypeScript and cURL).
- Improved workflow guidance showing how to trigger notifications from configuration to delivery for easier onboarding.

linear · 2025-10-23T19:17:43Z

netlify · 2025-10-23T19:17:47Z

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

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

coderabbitai · 2025-10-23T19:18:39Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Expanded the Pushpad integration doc into a step-by-step configuration and usage guide covering credential retrieval, dashboard setup, subscriber registration, and example API/SDK snippets for registering uids and sending notifications via Novu.

Changes

Cohort / File(s)	Summary
Pushpad integration docs `content/docs/platform/integrations/push/(providers)/pushpad.mdx`	Rewrote and expanded the Pushpad integration page into a detailed guide. Added sections for creating a Pushpad project, obtaining Project ID and access token, configuring credentials in Novu, registering subscriber uids (SDK example), updating subscriber credentials via API (TypeScript and cURL), and triggering notifications through Novu workflows. Updated examples to include provider IDs, integration identifiers, and device tokens.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Developer
  participant Pushpad
  participant Novu
  participant ClientSDK

  rect rgba(54,162,235,0.08)
    Developer->>Pushpad: Create project -> obtain Project ID & Access Token
    Developer->>Novu: Add Pushpad credentials (Project ID, Token) in Integrations
  end

  rect rgba(75,192,192,0.06)
    ClientSDK->>Pushpad: Register user uid and device token
    Pushpad-->>ClientSDK: Confirmation (device registered)
    ClientSDK->>Novu: (optional) Update subscriber with device token via API
    Novu-->>ClientSDK: Subscriber updated
  end

  rect rgba(153,102,255,0.06)
    Developer->>Novu: Create workflow / trigger notification (provider: Pushpad)
    Novu->>Pushpad: Send notification with provider integration & device token
    Pushpad-->>ClientSDK: Deliver push notification
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Docs-only change, moderate length and examples to verify.
Pay attention to: code snippets (TypeScript and cURL) for correctness, credential naming consistency (Project ID, access token, provider/integration IDs), and any copy/paste placeholders.

Suggested reviewers

jainpawan21

Poem

🐰
A token found, a uid in place,
I hopped through docs to find the trace.
From Pushpad's key to Novu's gate,
Notifications leap — oh what a state! 🥕✨

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 pull request title "Update content on Pushpad guide" is directly related to the changeset, which updates the Pushpad integration documentation file with a comprehensive, step-by-step guide. The title accurately identifies that the Pushpad guide content has been modified and is specific enough that a teammate scanning the repository history would understand the primary change is an update to Pushpad documentation. While the title could be more descriptive about the nature of the enhancement (e.g., specifying that it adds step-by-step setup instructions), it is not misleading, vague like "misc updates," or off-topic.

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: 0

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)/pushpad.mdx (1)
84-88: Fix invalid JSON syntax in the cURL example.

Line 86 uses single quotes around the string value, which violates JSON specification. JSON requires double quotes for all string values.

Apply this diff to correct the JSON syntax:
-d '{
  "providerId": "pushpad",
-  "deviceTokens": ['user123'],
+  "deviceTokens": ["user123"],
  "integrationIdentifier": "pushpad-MnGLxp8uy"
}'

🧹 Nitpick comments (1)

content/docs/platform/integrations/push/(providers)/pushpad.mdx (1)
71-71: Align deviceTokens examples between Node.js and cURL.

The Node.js example (line 71) shows multiple generic tokens, while the cURL example (line 86) shows a single uid. For consistency and clarity, both examples should demonstrate the same pattern. Since the guide explains that uid is the identifier to use (line 49), both examples should consistently demonstrate this pattern.

Consider updating the Node.js example to align with the uid pattern:
 credentials: {
-  deviceTokens: ["token1", "token2", "token3"],
+  deviceTokens: ["user123"],
 },
Alternatively, update the cURL example to show multiple tokens like the Node.js example for demonstration purposes.

Also applies to: 86-86

📜 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 8de9455.

⛔ Files ignored due to path filters (5)

public/images/channels-and-providers/push/pushpad/access-token.png is excluded by !**/*.png
public/images/channels-and-providers/push/pushpad/add-token.png is excluded by !**/*.png
public/images/channels-and-providers/push/pushpad/new-project.png is excluded by !**/*.png
public/images/channels-and-providers/push/pushpad/project-id.png is excluded by !**/*.png
public/images/channels-and-providers/push/pushpad/pushpad-integration.png is excluded by !**/*.png

📒 Files selected for processing (1)

content/docs/platform/integrations/push/(providers)/pushpad.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 (2)

content/docs/platform/integrations/push/(providers)/pushpad.mdx (2)

37-37: Cross-references and external links are properly formatted.

The internal cross-reference to Step 1 (line 37) uses correct markdown anchor formatting, and external links to Pushpad documentation include appropriate security attributes (target="_blank" and rel="noopener noreferrer").

Also applies to: 47-47, 23-23

6-116: Excellent restructuring of the Pushpad integration guide.

The documentation has been significantly improved from a minimal setup mention to a comprehensive, step-by-step guide. The logical flow (credentials → connection → subscriber setup → sending notifications) guides users effectively. Clear instructions with image references and code examples in multiple languages make this highly usable.

coderabbitai