Webhook event types #1010
Webhook event types #1010
Conversation
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
This reverts commit 5a59916.
|
Warning Rate limit exceeded@Aviatorscode2 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 24 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request adds comprehensive webhooks documentation, including event-type categorization and implementation guidance, while refining the environments documentation with improved wording and expanded publishing workflow steps. The platform navigation structure is updated to introduce a new Developer section. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
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 |
DianaHackmamba
left a comment
DianaHackmamba
left a comment
There was a problem hiding this comment.
Take another self editing pass. Lots of stacked headings, missing thens with ifs, misused may/might, and inconsistent heading capitalization.
Co-authored-by: DianaHackmamba <[email protected]>
|
…into webhook-event-types
Co-authored-by: DianaHackmamba <[email protected]>
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
♻️ Duplicate comments (2)
content/docs/platform/developer/environments.mdx (1)
7-7: Fix contraction error: "it's" → "its".Line 7 uses "it's" (contraction of "it is") when the possessive "its" is needed.
-Novu uses environments to separate your workflows and it's data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment. +Novu uses environments to separate your workflows and its data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment.content/docs/platform/developer/webhooks/index.mdx (1)
37-37: Remove extra blank line.There is an unnecessary blank line following the optional advanced settings note. Per the PR author's self-review feedback, extra whitespace between sections should be minimized.
 7. (Optional) Configure [advanced settings](/platform/developer/webhooks#advanced-configuration) for rate limits, transformations, and custom headers. 8. Click **Create**. - -<Callout>If your endpoint isn't ready, you can use tools like [Webhook.site](https://webhook.site/) or [RequestBin](https://requestbin.com/) to generate a temporary URL for testing.</Callout> +<Callout>If your endpoint isn't ready, you can use tools like [Webhook.site](https://webhook.site/) or [RequestBin](https://requestbin.com/) to generate a temporary URL for testing.</Callout>
🧹 Nitpick comments (3)
content/docs/platform/developer/webhooks/index.mdx (1)
60-60: Review stacked headings throughout the document.Per the PR author's self-review feedback, there are multiple instances where section headings (##) are immediately followed by subsection headings (###) without introductory content:
- Line 60 (## Verify your webhooks signatures) → line 62 starts content (this one is acceptable)
- Line 139 (## Managing webhooks endpoints) → line 141 immediately has ### Enable or disable an endpoint
- Line 152 (### Delete an endpoint) following ### Enable or disable an endpoint
- Line 162 (## Troubleshooting) → line 164 starts content without intro
- Line 182 (## Frequently asked questions) → line 184 immediately has ### How do I secure my webhook endpoint?
Consider adding brief introductory sentences before subsections to provide context and improve document flow.
Also applies to: 139-139, 152-152, 162-162, 182-182
content/docs/platform/developer/environments.mdx (2)
34-36: Remove redundant explanatory sentence.Lines 34–36 repeat the same concept. Line 36 restates that environments have isolated resources with some shareable/publishable assets. Consolidate into a single, clearer statement.
-Each environment in Novu has its own isolated resources, while the development environment has assets that can be published to other environments. - -Each environment maintains some isolated set of resources, while you can share or promote other assets through publishing. +Each environment in Novu maintains its own isolated resources for some assets (like subscribers and API keys), while development-environment-managed assets (like workflows and layouts) can be published to other environments.
87-87: Reduce "want to" repetition in list items.The list item at line 87 uses "want to publish" after similar phrasing appears in prior context. Vary the language to improve readability.
-4. Select the checkboxes next to the workflows that you want to publish. A menu appears, showing all the available workflows. +4. Select the checkboxes next to the workflows you wish to publish. A menu appears, showing all available workflows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (10)
public/images/developer-tools/add-webhook.pngis excluded by!**/*.pngpublic/images/developer-tools/after-testing.pngis excluded by!**/*.pngpublic/images/developer-tools/delivery-attempts.pngis excluded by!**/*.pngpublic/images/developer-tools/disable-endpoint.pngis excluded by!**/*.pngpublic/images/developer-tools/recover-menu.pngis excluded by!**/*.pngpublic/images/developer-tools/recover.pngis excluded by!**/*.pngpublic/images/developer-tools/replay-menu.pngis excluded by!**/*.pngpublic/images/developer-tools/resend-event.pngis excluded by!**/*.pngpublic/images/developer-tools/testing-endpoints.pngis excluded by!**/*.pngpublic/images/developer-tools/webhook-integrations.pngis excluded by!**/*.png
📒 Files selected for processing (7)
content/docs/platform/concepts/environments.mdx(0 hunks)content/docs/platform/developer/environments.mdx(1 hunks)content/docs/platform/developer/meta.json(1 hunks)content/docs/platform/developer/webhooks/event-types.mdx(1 hunks)content/docs/platform/developer/webhooks/index.mdx(1 hunks)content/docs/platform/developer/webhooks/meta.json(1 hunks)content/docs/platform/meta.json(1 hunks)
💤 Files with no reviewable changes (1)
- content/docs/platform/concepts/environments.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/developer/webhooks/index.mdx
[style] ~49-~49: Consider a more expressive alternative.
Context: ...can test it to be sure it's working. To do this: 1. Click on the endpoint you want...
(DO_ACHIEVE)
[style] ~52-~52: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ting** tab. 3. Select an event type you want to test with. 
[style] ~56-~56: Consider removing “of” to be more concise
Context: ...vent, you can view the message payload, all of the message attempts, and whether it succee...
(ALL_OF_THE)
[style] ~120-~120: Consider a more expressive alternative.
Context: ... a particular endpoint to be resent. To do this: 1. Click on the endpoint from the...
(DO_ACHIEVE)
[grammar] ~125-~125: Ensure spelling is correct
Context: ...eriod. For example, you can recover all fialed messages in the last 8 hours. ![Recov...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~135-~135: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...** tab. 2. Click the (...) icon. 3. Click Replay missing messages. 4. On the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/docs/platform/developer/environments.mdx
[style] ~87-~87: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...eckboxes next to the workflows that you want to publish. A menu appears, showing all th...
(REP_WANT_TO_VB)
⏰ 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/platform/developer/meta.json (1)
1-3: Metadata structure looks good.The pages array correctly includes both "environments" and "webhooks" in the intended order.
content/docs/platform/developer/webhooks/meta.json (1)
1-4: Metadata structure looks good.The icon and pages array are correctly configured for the webhooks documentation section.
content/docs/platform/meta.json (1)
34-42: Navigation structure is correctly organized.The new "---Developer---" section is properly introduced with the two new pages (environments and webhooks), and the "---Account---" section is appropriately repositioned. All existing account entries are preserved.
|
|
||
| Each event includes detailed information about the affected resource and the changes that occurred. | ||
|
|
||
| ## Message events |
There was a problem hiding this comment.
Reorder event type sections to match intro list order.
Per past review feedback, the event type sections should appear in the same order as the introductory list (lines 9–11):
- Workflow events
- Message events
- Preference events
Currently, they are ordered: Message (line 15), Preference (line 57), Workflow (line 63). Reorder the sections to match the introduction for better document flow and user expectations.
Consider also adding a brief introductory sentence before each event category section to provide context, reducing the "stacked heading" effect that the PR author flagged.
Also applies to: 57-57, 63-63
🤖 Prompt for AI Agents
In content/docs/platform/developer/webhooks/event-types.mdx around lines 15, 57
and 63, the three event category sections are out of order (currently Message at
15, Preference at 57, Workflow at 63) and should be reordered to match the intro
list order (Workflow, Message, Preference); move the Workflow section to appear
first, then Message, then Preference, and add a one-sentence intro paragraph
before each category heading to provide context and reduce the stacked-heading
effect.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…into webhook-event-types
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
content/docs/platform/developer/webhooks/index.mdx (2)
44-44: Fix grammar: "let's" → "lets".Line 44 incorrectly uses the contraction "let's" instead of the verb "lets".
- - **Transformations**: Novu uses Svix transformations feature, it let's you modify a webhook's payload and redirect it to a different URL. <a href="https://docs.svix.com/transformations" target="_blank" rel="noopener noreferrer">Visit Svix documentation</a> to learn more. + - **Transformations**: Novu uses Svix transformations feature, it lets you modify a webhook's payload and redirect it to a different URL. <a href="https://docs.svix.com/transformations" target="_blank" rel="noopener noreferrer">Visit Svix documentation</a> to learn more.
48-56: Tighten repetitive phrasing for conciseness.Lines 48, 51, and 55 contain wordy or repetitive language that should be streamlined:
-After you've added an endpoint, you can test it to be sure it's working. To do this: +After adding an endpoint, test it by following these steps: 1. Click on the endpoint you want to test. 2. Click the **Testing** tab. -3. Select an event type you want to test with. +3. Select an event type to test with.  4. Click **Send Example**. -After sending an example event, you can view the message payload, all of the message attempts, and whether it succeeded or failed. +After sending an example event, you can view the message payload, all message attempts, and whether it succeeded or failed.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
content/docs/platform/developer/environments.mdx(2 hunks)content/docs/platform/developer/webhooks/event-types.mdx(1 hunks)content/docs/platform/developer/webhooks/index.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- content/docs/platform/developer/webhooks/event-types.mdx
- content/docs/platform/developer/environments.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/developer/webhooks/index.mdx
[style] ~48-~48: Consider a more expressive alternative.
Context: ...can test it to be sure it's working. To do this: 1. Click on the endpoint you want...
(DO_ACHIEVE)
[style] ~51-~51: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ting** tab. 3. Select an event type you want to test with. 
[style] ~55-~55: Consider removing “of” to be more concise
Context: ...vent, you can view the message payload, all of the message attempts, and whether it succee...
(ALL_OF_THE)
[style] ~119-~119: Consider a more expressive alternative.
Context: ... a particular endpoint to be resent. To do this: 1. Click on the endpoint from the...
(DO_ACHIEVE)
[style] ~140-~140: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...** tab. 2. Click the (...) icon. 3. Click Replay missing messages. 4. On the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| </Step> | ||
|
|
||
| <Step title="Configure Distribution Settings"> | ||
| Go to Manage Distribution and at the bottom of the page, tick Remove Hard Coded Information and Activate Public Distribution. |
There was a problem hiding this comment.
Do not use "tick." Use "select."
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.