Content for email activity tracking

[Aviatorscode2]

Summary by CodeRabbit

• Documentation
  • Added comprehensive Email Activity Tracking docs: overview, event flow, provider-to-status mapping, viewing data, and enablement steps.
  • Added manual configuration guides for SES, SendGrid, Mailgun, and Resend with step‑by‑step instructions and visuals.
  • Renamed "Outbound Webhooks" to "Webhooks" in developer docs and removed the icon from the email integrations index.
• Chores
  • Updated docs navigation metadata to surface new activity-tracking and developer/platform pages.

[linear]

MRK-1048 Create docs page for supported webhook providers and events

[netlify]

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

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

[coderabbitai]

Walkthrough

Adds Email Activity Tracking documentation and provider manual-configuration pages; updates docs navigation metadata for platform and developer sections; tweaks frontmatter in email and webhooks pages. No code, runtime behavior, or public API changes.

Changes

Cohort / File(s)	Summary
Activity tracking overview content/docs/platform/integrations/email/activity-tracking/index.mdx	New overview page describing Email Activity Tracking: event flow, mapping to Novu statuses, UI surfaces, and use cases.
Provider manual guides content/docs/platform/integrations/email/activity-tracking/manual-configuration/* content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx, .../mailgun.mdx, .../resend.mdx, .../sendgrid.mdx	New provider-specific manual configuration pages (SES, Mailgun, Resend, SendGrid) with step-by-step instructions, required settings, screenshots, and troubleshooting.
Activity-tracking metadata content/docs/platform/integrations/email/activity-tracking/meta.json, content/docs/platform/integrations/email/activity-tracking/manual-configuration/meta.json	New meta.json files registering activity-tracking and its manual-configuration/provider pages.
Platform & developer navigation content/docs/platform/meta.json, content/docs/platform/developer/meta.json	Updated platform navigation pages arrays and added webhooks entry to developer meta.json.
Email integration metadata content/docs/platform/integrations/email/meta.json	Added activity-tracking to the email integration pages array.
Frontmatter tweaks content/docs/platform/integrations/email/index.mdx, content/docs/platform/developer/webhooks.mdx	Removed icon frontmatter from email index and updated developer webhooks page metadata (title changed to "Webhooks").

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Provider as Email Provider
  participant Inbound as Novu Inbound Webhook
  participant Normalizer as Event Normalizer
  participant Tracing as Step-Run Tracing
  participant Activity as Activity Feed
  participant Outbound as Outbound Webhooks

  rect rgba(173,216,230,0.12)
    Provider->>Inbound: Emit event (delivered/open/click/bounce/...)
    Inbound->>Normalizer: Deliver raw payload
    Normalizer->>Tracing: Map to Novu status & enrich
    Tracing->>Activity: Record event for UI/analytics
  end

  alt Outbound enabled
    rect rgba(200,230,201,0.12)
      Tracing-->>Outbound: Forward normalized event
    end
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Mrk 949 localization #917 — Modifies content/docs/platform/meta.json; likely overlaps with navigation ordering/entries.
• Edit styling page #920 — Also edits content/docs/platform/meta.json; may conflict with pages array changes.

Suggested reviewers

• jainpawan21
• DianaHackmamba

Poem

I hop through docs with whiskers bright,
Webhooks mapped from day to night.
SES, Mailgun, Resend in tune,
SendGrid hums beneath the moon.
Meta set — I nibble a carrot of delight 🥕✨

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.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Title Check	✅ Passed	The pull request title clearly describes the primary change by indicating that new content for email activity tracking has been added to the documentation, matching the main focus of the changeset without extraneous detail.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

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

---

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: 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 79137d1 and 819b57b.

⛔ Files ignored due to path filters (2)

• public/images/developer-tools/enable-inbound.png is excluded by !**/*.png
• public/images/developer-tools/inbound-enabled.png is excluded by !**/*.png

📒 Files selected for processing (5)

• content/docs/platform/developer/meta.json (1 hunks)
• content/docs/platform/developer/webhooks/inbound-webhooks.mdx (1 hunks)
• content/docs/platform/developer/webhooks/meta.json (1 hunks)
• content/docs/platform/developer/webhooks/outbound-webhooks.mdx (1 hunks)
• content/docs/platform/meta.json (1 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/developer/webhooks/outbound-webhooks.mdx (1)

5-5: Icon choice looks good.

Line 5: Swapping to the Upload icon makes sense for outbound-specific visuals and stays consistent with the new Webhooks subsection.

content/docs/platform/meta.json (1)

48-49: Navigation entry plugs in cleanly.

Lines 48-49: Adding the ---Developer--- divider and ...developer pointer follows the existing metadata convention, so the new section should surface as expected.

content/docs/platform/developer/meta.json (1)

1-3: Parent metadata is wired correctly.

Lines 1-3: The Developer meta file now delegates to the Webhooks subsection, aligning with the new navigation entry.

content/docs/platform/developer/webhooks/meta.json (1)

1-6: Webhooks subsection metadata looks solid.

Lines 1-6: Title/icon/page configuration matches the rest of the docs structure, so both inbound and outbound pages should show up under Developer → Webhooks with the right iconography.

[djabarovgeorge]

Looks great! I left a few comments. The only part I see missing is how to manually configure each provider if auto-configuration fails

[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/email/activity-tracking/manual-configuration/mailgun.mdx (1)

1-9: Provide actionable Mailgun configuration steps.

This manual-configuration page stops at a high-level description and never explains how to set up Mailgun inbound webhooks in Novu. Users following the activity-tracking flow are left without the provider-specific steps they came here for, making the page unusable. Please add the detailed Mailgun configuration procedure (permissions, webhook creation, Novu UI linkage, etc.) so it matches the depth of the other provider guides.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef2a03c and 3c34ec8.

⛔ Files ignored due to path filters (4)

• public/images/channels-and-providers/email/activity-tracking/custom-access.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/enable-activity-tracking.gif is excluded by !**/*.gif
• public/images/channels-and-providers/email/activity-tracking/sendgrid-api.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/sendgrid-endpoint-url.png is excluded by !**/*.png

📒 Files selected for processing (9)

• content/docs/platform/integrations/email/activity-tracking/index.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/mailgun.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/meta.json (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/resend.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/sendgrid.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/meta.json (1 hunks)
• content/docs/platform/integrations/email/index.mdx (0 hunks)
• content/docs/platform/integrations/email/meta.json (1 hunks)

💤 Files with no reviewable changes (1)

• content/docs/platform/integrations/email/index.mdx

✅ Files skipped from review due to trivial changes (5)

• content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx
• content/docs/platform/integrations/email/activity-tracking/index.mdx
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/meta.json
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/resend.mdx
• content/docs/platform/integrations/email/activity-tracking/meta.json

⏰ 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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 658ba17 and f4303f7.

⛔ Files ignored due to path filters (22)

• public/images/channels-and-providers/email/activity-tracking/ses/access-keys.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/account-dashboard.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/add-destination.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/create-access-key.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/create-set.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/create-subscription.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/create-topic.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/create-user.gif is excluded by !**/*.gif
• public/images/channels-and-providers/email/activity-tracking/ses/create-user.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/event-types.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/permissions.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/review-destination-details.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/ses-inbound-webhook.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/ses-integration.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/set-name-novu.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/set-name.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/sns-standard.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/sns-topic.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/sns.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/subscription-confirmed.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/subscription.png is excluded by !**/*.png
• public/images/channels-and-providers/email/activity-tracking/ses/user-details.png is excluded by !**/*.png

📒 Files selected for processing (3)

• content/docs/platform/integrations/email/activity-tracking/manual-configuration/mailgun.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/resend.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• content/docs/platform/integrations/email/activity-tracking/manual-configuration/mailgun.mdx

⏰ 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

[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 f4303f7 and 0781edf.

📒 Files selected for processing (1)

• content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx (1 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). (1)

• GitHub Check: Build and Lint

[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 0781edf and cf0c1fd.

📒 Files selected for processing (1)

• content/docs/platform/developer/webhooks.mdx (1 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

[coderabbitai]

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf0c1fd and 69d81b4.

📒 Files selected for processing (2)

• content/docs/platform/integrations/email/activity-tracking/index.mdx (1 hunks)
• content/docs/platform/integrations/email/activity-tracking/manual-configuration/ses.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• content/docs/platform/integrations/email/activity-tracking/index.mdx

⏰ 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