docs(webhooks): enhance message event documentation and clarify email activity tracking#1132
docs(webhooks): enhance message event documentation and clarify email activity tracking#1132jainpawan21 wants to merge 1 commit into
Conversation
… activity tracking Updated the message events section to explain the sources of `message.*` events and their relationship with email activity tracking. Added detailed descriptions for each event type, including `message.sent`, `message.delivered`, and `message.seen`. Clarified the necessity of enabling both email activity tracking and outbound webhooks for proper event handling. Improved troubleshooting guidance for common issues related to event visibility in Novu.
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughFive MDX documentation files were updated to clarify the relationship between Email Activity Tracking and Outbound Webhooks. The legacy Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
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 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| @@ -4,204 +4,9 @@ pageTitle: "Novu Webhooks Guide" | |||
| description: "Learn how Novu webhooks work, including event types, payload schemas, signature verification, and endpoint configuration." | |||
There was a problem hiding this comment.
description frontmatter still describes the old full-featured page. Search engines and Mintlify previews will surface this stale text when users land on what is now a near-empty legacy-notice page.
| description: "Learn how Novu webhooks work, including event types, payload schemas, signature verification, and endpoint configuration." | |
| description: "This page has moved. See the Webhooks overview for setup, signatures, and retries, and the Event types page for a full list of supported events." |
Prompt To Fix With AI
This is a comment left during a code review.
Path: content/docs/platform/developer/webhooks/webhooks.mdx
Line: 4
Comment:
The `description` frontmatter still describes the old full-featured page. Search engines and Mintlify previews will surface this stale text when users land on what is now a near-empty legacy-notice page.
```suggestion
description: "This page has moved. See the Webhooks overview for setup, signatures, and retries, and the Event types page for a full list of supported events."
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| 6. Click **Create new webhook** | ||
|  |
There was a problem hiding this comment.
| 6. Click **Create new webhook** | |
|  | |
| 6. Click **Create new webhook**. | |
|  |
Prompt To Fix With AI
This is a comment left during a code review.
Path: content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx
Line: 59-60
Comment:
Step 6 is missing a trailing period, inconsistent with every other step in the same list.
```suggestion
6. Click **Create new webhook**.
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
1 participant
Updated the message events section to explain the sources of
message.*events and their relationship with email activity tracking. Added detailed descriptions for each event type, includingmessage.sent,message.delivered, andmessage.seen. Clarified the necessity of enabling both email activity tracking and outbound webhooks for proper event handling. Improved troubleshooting guidance for common issues related to event visibility in Novu.Summary by CodeRabbit
Greptile Summary
This PR clarifies the relationship between Email Activity Tracking (inbound provider webhooks) and Outbound Webhooks (forwarding to user endpoints) across the webhooks and email integrations documentation. It also converts the old
webhooks.mdxpage into a legacy-notice stub pointing to the restructured docs.event-types.mdxandwebhooks/index.mdx: Adds a source-of-origin table formessage.*events and two new FAQ entries explaining whymessage.delivered/message.seenrequire activity tracking whilemessage.sentdoes not.activity-tracking/index.mdx: Adds a Callout separating the two configuration steps (activity tracking vs. outbound webhooks) and a mapping table showing provider events → Novu statuses → outbound webhook event names.sendgrid.mdx: Fixes typos and step numbering, adds a multiple-integrations Callout, an action-mapping table, and a troubleshooting section for common open/delivery-event gaps.Confidence Score: 4/5
Safe to merge — all changes are documentation-only with no code or configuration logic affected.
The content additions are accurate and internally consistent. The only notable gap is that webhooks.mdx frontmatter description still describes the old full page, which will show stale text in search results and doc previews until corrected.
content/docs/platform/developer/webhooks/webhooks.mdx — the frontmatter description should be updated to match the now-minimal legacy-notice content.
Important Files Changed
Sequence Diagram
%%{init: {'theme': 'neutral'}}%% sequenceDiagram participant Novu participant Provider as Email Provider (e.g. SendGrid) participant InboundWebhook as Novu Inbound Webhook participant OutboundWebhook as Your Outbound Endpoint Novu->>Provider: Send email Novu-->>OutboundWebhook: message.sent (no activity tracking needed) Provider->>InboundWebhook: delivered event (requires Activity Tracking enabled) InboundWebhook->>Novu: normalize to delivered status Novu-->>OutboundWebhook: message.delivered Provider->>InboundWebhook: open event (requires Activity Tracking enabled) InboundWebhook->>Novu: normalize to opened status Novu-->>OutboundWebhook: message.seen (not message.opened) Provider->>InboundWebhook: bounce / dropped / blocked InboundWebhook->>Novu: normalize to bounced / dropped / blocked Novu-->>OutboundWebhook: message.failed%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% sequenceDiagram participant Novu participant Provider as Email Provider (e.g. SendGrid) participant InboundWebhook as Novu Inbound Webhook participant OutboundWebhook as Your Outbound Endpoint Novu->>Provider: Send email Novu-->>OutboundWebhook: message.sent (no activity tracking needed) Provider->>InboundWebhook: delivered event (requires Activity Tracking enabled) InboundWebhook->>Novu: normalize to delivered status Novu-->>OutboundWebhook: message.delivered Provider->>InboundWebhook: open event (requires Activity Tracking enabled) InboundWebhook->>Novu: normalize to opened status Novu-->>OutboundWebhook: message.seen (not message.opened) Provider->>InboundWebhook: bounce / dropped / blocked InboundWebhook->>Novu: normalize to bounced / dropped / blocked Novu-->>OutboundWebhook: message.failedPrompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs(webhooks): enhance message event do..." | Re-trigger Greptile