Skip to content

Update docs for webhook notifier#923

Merged
MJYoung114 merged 5 commits into
mainfrom
mike/hos-1194-webhook-docs-and-incidentio-setup-guide
May 19, 2026
Merged

Update docs for webhook notifier#923
MJYoung114 merged 5 commits into
mainfrom
mike/hos-1194-webhook-docs-and-incidentio-setup-guide

Conversation

@MJYoung114
Copy link
Copy Markdown
Contributor

@MJYoung114 MJYoung114 commented May 18, 2026

Summary by CodeRabbit

  • Documentation
    • Added Notification Channels docs covering Discord, Slack, Telegram, Email, and Webhook, including webhook payload schema, field descriptions, and note that endsAt is omitted for firing alerts.
    • Added incident.io integration guide with mapping, severity mapping, deduplication key guidance, and setup steps.
    • Added Katana network docs with configuration examples.
    • Updated supported networks: Katana added; Sentient and Sentient Testnet removed.

Review Change Stack

@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
envio-docs Ready Ready Preview, Comment May 19, 2026 11:23am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

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

Changes

Webhook-based Alerting and Incident.io Integration

Layer / File(s) Summary
Notification Channels
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
Documents supported notification channels and where channels are configured vs subscribed.
Webhook payload schema and field descriptions
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
Describes webhook HTTP POST delivery, optional custom headers, structured JSON payload schema (includes note that endsAt is omitted for firing alerts), and per-field descriptions.
incident.io integration and wiring
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
Adds incident.io custom HTTP source setup, ES5 transform mapping example (severity mapping, metadata serialization), deduplication key = alert_id, and Envio-side webhook channel wiring instructions.

Katana Network Support

Layer / File(s) Summary
Katana Network Documentation Page
docs/HyperIndex/supported-networks/katana.md
New network doc with chain ID, HyperSync/HyperRPC endpoints, Bronze tier marker, indexing/sync/read-only RPC overview, and YAML indexer configuration example.
Network Registry and Reference Updates
docs/HyperRPC/hyperrpc-supported-networks.md, docs/HyperSync/hypersync-supported-networks.md, supported-networks.json
Adds Katana to HyperRPC and HyperSync tables and to supported-networks.json; removes Sentient and Sentient Testnet entries from those references.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • DenhamPreen
  • DZakh
  • moose-code
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update docs for webhook notifier' accurately describes the primary change, but the PR also includes substantial documentation additions for Katana network support and updates to multiple supported networks tables.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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

🤖 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

📥 Commits

Reviewing files that changed from the base of the PR and between 826bb55 and e5e1445.

📒 Files selected for processing (5)
  • docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
  • docs/HyperIndex/supported-networks/katana.md
  • docs/HyperRPC/hyperrpc-supported-networks.md
  • docs/HyperSync/hypersync-supported-networks.md
  • supported-networks.json

Comment thread docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
Copy link
Copy Markdown
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

♻️ Duplicate comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md (1)

147-165: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Add alert_id to 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 include alert_id. Since incident.io evaluates the dedup key path against the transformed payload, a missing alert_id will 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

📥 Commits

Reviewing files that changed from the base of the PR and between 070beb2 and cc78267.

📒 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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.

@MJYoung114 MJYoung114 force-pushed the mike/hos-1194-webhook-docs-and-incidentio-setup-guide branch from 4a6010a to 470aad2 Compare May 19, 2026 11:19
@MJYoung114 MJYoung114 merged commit 55ea0bc into main May 19, 2026
3 checks passed
@MJYoung114 MJYoung114 deleted the mike/hos-1194-webhook-docs-and-incidentio-setup-guide branch May 19, 2026 11:24
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.

3 participants