feat: add payload limits documentation and update API reference

[merrcury]

This pull request adds comprehensive documentation for API payload limits, clarifying the size restrictions for event triggers and how they are enforced. It introduces a new "Payload Limits" page in the API reference, detailing the 512KB payload size limit, error messages, and attachment handling.

Documentation improvements:

• Added a new payload-limits.mdx page documenting the 512KB payload size limit for event triggers, including what counts towards the limit, error message formats, and separate attachment limits.
• Updated meta.json to include the new "Payload Limits" page in the API reference navigation.

Summary by CodeRabbit

• Documentation
  • Added API reference explaining payload size rules: 512KB global limit for event endpoints, 20MB total attachment limit (attachments excluded from the 512KB calculation), per-item validation for bulk requests, and example error responses for single, bulk, and broadcast triggers.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new API reference page documenting payload size limits (512KB for trigger/bulk/broadcast events, attachments excluded) and registers it in the API reference navigation (meta.json). Provides error examples, per-item bulk validation notes, and attachment size guidance.

Changes

Cohort / File(s)	Summary
Documentation Navigation content/docs/api-reference/meta.json	Inserted "payload-limits" into the top-level pages array for the API reference.
Payload Limits Reference content/docs/api-reference/payload-limits.mdx	Added new MDX page describing the 512KB payload limit for Trigger Event, Bulk Trigger Event, and Broadcast Event endpoints; attachments excluded from that limit (separate attachment limits, e.g., 20MB for email attachments); outlines what counts toward the limit, per-item bulk validation, and example 413 error responses.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 With nimble paws I hop and write,

I log the bounds of bytes tonight.
Five-one-two the magic tune,
Attachments dance outside the room.
Hooray—clear guides for every flight! 🎉

🚥 Pre-merge checks | ✅ 3

✅ 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 directly and clearly summarizes the main changes: adding payload limits documentation and updating the API reference navigation. It is concise and specific.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d3b95c and 4640117.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (1)

• content/docs/api-reference/payload-limits.mdx

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

• content/docs/api-reference/payload-limits.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

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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.}

[netlify]

✅ Deploy Preview for docs-novu ready!

Name	Link
🔨 Latest commit	4640117
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/6967b16f78dd6f0009f4790f
😎 Deploy Preview	https://deploy-preview-1034--docs-novu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

content/docs/api-reference/payload-limits.mdx (1)

7-7: Consider minor wording improvement.

The phrase "an essential functionality" could be simplified to "an essential feature" or "essential for" for better readability.

✨ Suggested wording improvement

-Payload size limits are an essential functionality for ensuring optimal performance and reliability of the system. They safeguard system resources by preventing oversized payloads from impacting API performance and ensure efficient processing of event triggers.
+Payload size limits are essential for ensuring optimal performance and reliability of the system. They safeguard system resources by preventing oversized payloads from impacting API performance and ensure efficient processing of event triggers.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c58c3b4 and 9d3b95c.

📒 Files selected for processing (2)

• content/docs/api-reference/meta.json
• content/docs/api-reference/payload-limits.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). (3)

• GitHub Check: Redirect rules - docs-novu
• GitHub Check: Header rules - docs-novu
• GitHub Check: Pages changed - docs-novu

🔇 Additional comments (3)

content/docs/api-reference/payload-limits.mdx (2)

80-80: Verify the attachment documentation link path.

The link uses an absolute path format (/platform/integrations/email#sending-attachments). Ensure this matches the documentation site's routing conventions and that the anchor #sending-attachments exists in the target page.

The verification script above will help locate the email integration documentation. Please confirm the link format and anchor are correct for your documentation framework.

---

1-88: Documentation is accurate with all links verified.

The payload-limits documentation is well-structured with accurate technical information:

• All referenced links exist: rate-limiting, trigger-event, bulk-trigger-event, broadcast-event-to-all, and the sending-attachments section in email/index.mdx
• The 20MB attachment limit is confirmed in existing documentation
• Mathematical accuracy verified: 512KB = 524,288 bytes
• Error example is realistic: 524,342 bytes is 54 bytes over the 512KB limit

The documentation is ready to be published. To ensure the error message formats match actual API responses exactly, this should be confirmed with the API team before final release.

content/docs/api-reference/meta.json (1)

8-8: Appropriate navigation placement.

The "payload-limits" entry is correctly positioned in the "Getting Started" section alongside other foundational API concepts (rate-limiting, idempotency). The slug matches the filename convention.

[merrcury]

Team, Is this page live?