Docs for the push activity tracking #984
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughAdds a new documentation page "push-activity-tracking" describing a client→backend→Novu flow for push notification activity tracking, and updates the push integration metadata to include that page. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant U as Client App
participant B as App Backend
participant N as Novu API
participant F as Novu Activity Feed
rect rgba(200,230,255,0.25)
note over U: Step 2 — capture push interaction on device
U->>B: POST /track-push {eventType,eventId,timestamp,content,deviceId,platform}
end
rect rgba(220,255,220,0.25)
note over B: Step 3 — backend forwards to Novu
B->>N: trackActivity({environmentId,integrationId,requestBody})
N-->>B: HTTP 2xx/4xx
end
rect rgba(255,240,200,0.25)
note over N,F: Step 4 — event appears in Activity Feed
N-->>F: store/display event
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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. Comment |
❌ Deploy Preview for docs-novu failed. Why did it fail? →
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
public/images/channels-and-providers/push/activity-tracking/enable-activity-tracking.pngis excluded by!**/*.png
📒 Files selected for processing (2)
content/docs/platform/integrations/push/meta.json(1 hunks)content/docs/platform/integrations/push/push-activity-tracking.mdx(1 hunks)
Comment on lines
+7
to
+18
| Push notification providers typically do not offer native webhhoks support that can be used for activity tracking. To enable activity tracking for Push channels notifications, Novu supports a manual integration approach for push notifications. | ||
|
|
||
| Where your application captures and forwards push notification events to the Novu. Once received, Novu processes and displays these events alongside other channels for a unified tracking experience. | ||
|
|
||
| ## How it works | ||
|
|
||
| The process involves four-step data flow from your subscriber's device to Novu's servers: | ||
|
|
||
| 1. **Client application listens:** Your application listens for push notification interactions (e.g., the user opening a notification). | ||
| 2. **Event sent to your backend:** When an event occurs, your app sends a payload containing the event details to an endpoint on your own server. | ||
| 3. **Backend forwards to Novu:** Your server receives this data and uses the Novu SDK to securely forward the event to Novu's API. | ||
| 4. **Event appears in Novu:** Novu processes the event and displays it in the **Activity Feed**, alongside events from your other channels. |
There was a problem hiding this comment.
Fix typos and fluent phrasing in the introduction.
Please correct: “webhhoks” → “webhooks,” drop the extra “the” before “Novu,” and change “four-step data flow” → “a four-step data flow” for readability.
🤖 Prompt for AI Agents
In content/docs/platform/integrations/push/push-activity-tracking.mdx around
lines 7 to 18, fix typos and improve phrasing in the introductory paragraph:
change “webhhoks” to “webhooks”, remove the extra “the” before “Novu” so it
reads “forwards push notification events to Novu”, and change “four-step data
flow” to “a four-step data flow”; ensure the sentences remain fluent and
grammatically correct after these edits.
Comment on lines
+34
to
+39
| Next, when push notifications are delivered or interacted with, your app needs to capture those events and forward them to your backend. The exact code implementation will depends on the push provider you use. | ||
|
|
||
| The goal is to capture the event and send a JSON payload to your backend. The two most important fields to send are: | ||
| - `eventType`: A string describing the event (for example, `opened`, `clicked`). | ||
| - `eventId`: The unique identifier for the notification, which Novu includes in the push payload as `__nvMessageId`. | ||
|
|
There was a problem hiding this comment.
Tighten the wording in Step 2.
Change “will depends” to “will depend” to keep the prose grammatically correct.
🤖 Prompt for AI Agents
In content/docs/platform/integrations/push/push-activity-tracking.mdx around
lines 34 to 39, fix the grammatical typo "will depends" to "will depend" so the
sentence reads correctly; update the sentence accordingly and run a quick
spell/grammar check nearby for similar issues.
content/docs/platform/integrations/push/push-activity-tracking.mdx
Outdated
Show resolved
Hide resolved
….mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
DianaHackmamba
requested changes
Oct 15, 2025
| description: 'Learn how to manually forward push notification events from your application to Novu for unified activity tracking.' | ||
| --- | ||
|
|
||
| Push notification providers typically do not offer native webhhoks support that can be used for activity tracking. To enable activity tracking for Push channels notifications, Novu supports a manual integration approach for push notifications. |
There was a problem hiding this comment.
Suggested change
| Push notification providers typically do not offer native webhhoks support that can be used for activity tracking. To enable activity tracking for Push channels notifications, Novu supports a manual integration approach for push notifications. | |
| Push notification providers typically do not offer native webhook support that can be used for activity tracking. To enable activity tracking for Push channels notifications, Novu supports a manual integration approach for push notifications. |
|
|
||
| Push notification providers typically do not offer native webhhoks support that can be used for activity tracking. To enable activity tracking for Push channels notifications, Novu supports a manual integration approach for push notifications. | ||
|
|
||
| Where your application captures and forwards push notification events to the Novu. Once received, Novu processes and displays these events alongside other channels for a unified tracking experience. |
There was a problem hiding this comment.
The first sentence in this paragraph is incomplete. Is it supposed to be a continuation from the previous paragraph?
|
|
||
| ## How it works | ||
|
|
||
| The process involves four-step data flow from your subscriber's device to Novu's servers: |
There was a problem hiding this comment.
Suggested change
| The process involves four-step data flow from your subscriber's device to Novu's servers: | |
| The process involves a four-step data flow from your subscriber's device to Novu's servers: |
|
|
||
| The process involves four-step data flow from your subscriber's device to Novu's servers: | ||
|
|
||
| 1. **Client application listens:** Your application listens for push notification interactions (e.g., the user opening a notification). |
There was a problem hiding this comment.
Do not use e.g. or i.e.
Also, the colon should be outside the bold formatting.
|
|
||
| The process involves four-step data flow from your subscriber's device to Novu's servers: | ||
|
|
||
| 1. **Client application listens:** Your application listens for push notification interactions (e.g., the user opening a notification). |
There was a problem hiding this comment.
Suggested change
| 1. **Client application listens:** Your application listens for push notification interactions (e.g., the user opening a notification). | |
| 1. **Client application listens**: Your application listens for push notification interactions. For example, the user opens a notification. |
| First, you need to enable the feature in your Novu dashboard and retrieve the necessary credentials. | ||
|
|
||
| 1. Log in to the Novu dashboard. | ||
| 2. Navigate to the **Integration Store** page and select your push provider. |
There was a problem hiding this comment.
Suggested change
| 2. Navigate to the **Integration Store** page and select your push provider. | |
| 2. Navigate to the **Integration Store** page and then select your push provider. |
| 2. Navigate to the **Integration Store** page and select your push provider. | ||
| 3. Enable the **Push Activity Tracking** toggle. | ||
|  | ||
| 4. Once enabled, your unique **Environment ID** and **Integration ID** will be displayed. Copy both of these; you will need them for your backend code. |
There was a problem hiding this comment.
Suggested change
| 4. Once enabled, your unique **Environment ID** and **Integration ID** will be displayed. Copy both of these; you will need them for your backend code. | |
| 4. Once enabled, your unique **Environment ID** and **Integration ID** are displayed. Copy both of these; you will need them for your backend code. |
|
|
||
| ## Step 2: Listen for push events in your app | ||
|
|
||
| Next, when push notifications are delivered or interacted with, your app needs to capture those events and forward them to your backend. The exact code implementation will depends on the push provider you use. |
There was a problem hiding this comment.
Suggested change
| Next, when push notifications are delivered or interacted with, your app needs to capture those events and forward them to your backend. The exact code implementation will depends on the push provider you use. | |
| Next, when push notifications are delivered or interacted with, your app needs to capture those events and forward them to your backend. The exact code implementation depends on the push provider that you use. |
|
|
||
| Next, when push notifications are delivered or interacted with, your app needs to capture those events and forward them to your backend. The exact code implementation will depends on the push provider you use. | ||
|
|
||
| The goal is to capture the event and send a JSON payload to your backend. The two most important fields to send are: |
There was a problem hiding this comment.
This implies there are more than two fields. As a reader, I want to know what they are.
| ``` | ||
| <Callout>Both `Integration ID` and `Environment ID` can be found in the Integration Store under your push provider instance (after enabling Push Activity Tracking).</Callout> | ||
|
|
||
| Once these steps are completed, your application will begin sending push notification engagement data to Novu, giving you a complete, unified view of your notification performance in the Activity Feed. No newline at end of file |
There was a problem hiding this comment.
Suggested change
| Once these steps are completed, your application will begin sending push notification engagement data to Novu, giving you a complete, unified view of your notification performance in the Activity Feed. | |
| Once these steps are completed, your application will send push notification engagement data to Novu, giving you a complete, unified view of your notification performance in the Activity Feed. |
There was a problem hiding this comment.
27 words. Break this sentence up.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit