Skip to content

Conversation

Aviatorscode2
Copy link
Contributor

@Aviatorscode2 Aviatorscode2 commented Sep 25, 2025

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Inbound Webhooks guide covering setup, event processing flow, provider status mappings (SendGrid, Mailgun, Resend, Amazon SES), analytics enrichment, and Activity Feed visibility.
    • Expanded and reorganized the Webhooks section for easier discovery (Inbound and Outbound pages).
    • Updated the Outbound Webhooks page icon for clearer visual identification.
    • Refreshed platform developer navigation to surface new related pages.

Copy link

linear bot commented Sep 25, 2025

Copy link

netlify bot commented Sep 25, 2025

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

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

Copy link
Contributor

coderabbitai bot commented Sep 25, 2025

Walkthrough

Adds a Developer docs section for Webhooks: a new inbound webhooks page, an updated outbound webhooks icon, and JSON metadata files to surface the Developer and Webhooks entries in the docs navigation.

Changes

Cohort / File(s) Summary of Changes
Developer section metadata
content/docs/platform/developer/meta.json, content/docs/platform/developer/webhooks/meta.json, content/docs/platform/meta.json
Added/updated JSON metadata to introduce a Developer section and a Webhooks subsection; defined pages arrays (["webhooks"], ["inbound-webhooks","outbound-webhooks"]) and inserted Developer entries into platform navigation.
Webhooks docs content
content/docs/platform/developer/webhooks/inbound-webhooks.mdx, content/docs/platform/developer/webhooks/outbound-webhooks.mdx
Added new Inbound Webhooks documentation page; changed frontmatter icon in Outbound Webhooks from Webhook to Upload.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Mrk 949 localization #917 — Modifies documentation navigation metadata and section meta files, overlapping with this PR’s platform/meta updates.

Suggested reviewers

  • jainpawan21
  • DianaHackmamba

Poem

I hop through docs with whiskers bright,
New webhooks gleam beneath moonlight.
Inbound pages, icons retold,
Meta stitched so paths unfold.
🐇✨

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.
Title Check ✅ Passed The title accurately highlights the addition of content for the inbound webhooks page, which is a significant aspect of the changeset, and it is concise and clear without using vague terms. Although the pull request also introduces metadata files and an outbound webhooks page, the title remains directly related to a real and important part of the updates. This partial relation satisfies the criteria for passing the title check.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch MRK-1048

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 819b57b and ef2a03c.

📒 Files selected for processing (1)
  • content/docs/platform/developer/webhooks/inbound-webhooks.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • content/docs/platform/developer/webhooks/inbound-webhooks.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

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant