Update docs for webhook notifier#923
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds Katana to supported-networks (docs, HyperRPC/HyperSync tables, registry) and extends Hosted Service monitoring docs with Notification Channels, a Webhook JSON payload schema (field descriptions), and incident.io integration and wiring instructions. ChangesWebhook-based Alerting and Incident.io Integration
Katana Network Support
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md`:
- Around line 139-163: The transform is missing the top-level alert_id required
by the dedup key path; update the transform return object (the function that
currently returns title, status, description, source_url, and metadata) to
include alert_id mapped from the incoming payload (e.g. body.alert_id or
body.metadata.alertId depending on the source field) so incident.io can evaluate
deduplication correctly and group/auto-resolve alerts.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e5ad7a18-86b1-4f2b-8655-7e9378e818c2
📒 Files selected for processing (5)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.mddocs/HyperIndex/supported-networks/katana.mddocs/HyperRPC/hyperrpc-supported-networks.mddocs/HyperSync/hypersync-supported-networks.mdsupported-networks.json
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md (1)
147-165:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winAdd
alert_idto the transform output to match the dedup key path.The guide sets dedup key path to
alert_id(Line 170), but the transform return object does not includealert_id. Since incident.io evaluates the dedup key path against the transformed payload, a missingalert_idwill cause incident.io to generate a random deduplication key for each alert, preventing proper grouping and auto-resolve functionality.🔧 Suggested fix
return { title: body.title, + alert_id: body.alert_id, status: body.status, description: body.description || "",🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md` around lines 147 - 165, The transform return object is missing alert_id (used as the dedup key), so add alert_id to the top-level returned object (alongside title, status, description, source_url) and populate it from the incoming payload (e.g., body.alert_id or body.metadata.alertId depending on source) so the dedup key path `alert_id` resolves correctly; update the function that builds and returns this object (the transform return block shown) to include alert_id and ensure it matches how alerts are identified upstream.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md`:
- Line 137: Edit the sentence "In the incident.io dashboard, Follow the
incident.io custom HTTP sources guide to setup the webhook integration." to fix
capitalization and article usage: make "Follow" lowercase ("follow"), remove the
redundant "the" before "incident.io", and change "setup" (noun) to the verb form
"set up"; the corrected phrase should read like "In the incident.io dashboard,
follow incident.io custom HTTP sources guide to set up the webhook integration."
Locate and update that exact sentence in hosted-service-monitoring.md.
---
Duplicate comments:
In `@docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md`:
- Around line 147-165: The transform return object is missing alert_id (used as
the dedup key), so add alert_id to the top-level returned object (alongside
title, status, description, source_url) and populate it from the incoming
payload (e.g., body.alert_id or body.metadata.alertId depending on source) so
the dedup key path `alert_id` resolves correctly; update the function that
builds and returns this object (the transform return block shown) to include
alert_id and ensure it matches how alerts are identified upstream.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ec7f5b5e-8a49-4695-b5ae-39328d611870
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
|
|
||
| **Step 1: Create a Custom HTTP Source in incident.io** | ||
|
|
||
| In the incident.io dashboard, Follow the incident.io [custom HTTP sources](https://docs.incident.io/alerts/custom-http-sources) guide to setup the webhook integration. |
There was a problem hiding this comment.
Fix capitalization and article usage.
"Follow the incident.io" should use lowercase "follow" after the comma and the article "the" is redundant.
📝 Suggested fix
-In the incident.io dashboard, Follow the incident.io [custom HTTP sources](https://docs.incident.io/alerts/custom-http-sources) guide to setup the webhook integration.
+In the incident.io dashboard, follow the [custom HTTP sources](https://docs.incident.io/alerts/custom-http-sources) guide to set up the webhook integration.Note: Also changed "setup" → "set up" (verb form).
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In the incident.io dashboard, Follow the incident.io [custom HTTP sources](https://docs.incident.io/alerts/custom-http-sources) guide to setup the webhook integration. | |
| In the incident.io dashboard, follow the [custom HTTP sources](https://docs.incident.io/alerts/custom-http-sources) guide to set up the webhook integration. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md` at line 137,
Edit the sentence "In the incident.io dashboard, Follow the incident.io custom
HTTP sources guide to setup the webhook integration." to fix capitalization and
article usage: make "Follow" lowercase ("follow"), remove the redundant "the"
before "incident.io", and change "setup" (noun) to the verb form "set up"; the
corrected phrase should read like "In the incident.io dashboard, follow
incident.io custom HTTP sources guide to set up the webhook integration." Locate
and update that exact sentence in hosted-service-monitoring.md.
4a6010a to
470aad2
Compare
Summary by CodeRabbit
endsAtis omitted for firing alerts.