Skip to content

ROB-3785 Reorganize webhook documentation under new webhooks directory#2080

Closed
naomi-robusta wants to merge 1 commit into
masterfrom
claude/add-webhook-changes-support-28CHR
Closed

ROB-3785 Reorganize webhook documentation under new webhooks directory#2080
naomi-robusta wants to merge 1 commit into
masterfrom
claude/add-webhook-changes-support-28CHR

Conversation

@naomi-robusta
Copy link
Copy Markdown
Contributor

Summary

Restructured the webhook integration documentation to create a unified "Send Events API" framework that encompasses both alerts and configuration changes. This improves the information architecture by consolidating related webhook integrations under a single parent concept.

Key Changes

  • Reorganized directory structure: Moved webhook documentation from docs/configuration/exporting/ to docs/configuration/webhooks/

    • Created new webhooks/ directory with send-events-api.rst as the parent document
    • Split functionality into two sub-APIs: send-alerts-api.rst and send-changes-api.rst
  • Expanded Send Events API: Enhanced the parent API documentation to cover both alert and change event types

    • Added examples for both alert and change event submissions
    • Documented support for multiple event types (type=alert and type=change)
    • Clarified that unknown origins are accepted and parsed generically
    • Added option to pass API key via query parameter (&token=) for vendors that cannot send custom headers
  • Added new change event integrations: Created documentation for three new change event sources

    • changes/launchdarkly.rst - Feature flag change tracking
    • changes/argocd.rst - GitOps deployment tracking
    • changes/github.rst - Code change and deployment tracking
  • Reorganized alert integrations: Moved existing alert integrations from send-events/ to alerts/ subdirectory

    • All 14 alert integration guides (AlertManager, Datadog, PagerDuty, etc.) relocated and updated with new paths
    • Simplified send-alerts-api.rst to reference the parent send-events-api.rst for common parameters
  • Updated navigation: Modified docs/configuration/index.rst and docs/index.rst to reference new webhook paths

    • Promoted "Send Events API" as the recommended integration path
    • Maintained backward compatibility references to legacy endpoints

Notable Implementation Details

  • The new structure establishes a clear hierarchy: Send Events API (parent) → Send Alerts API / Send Changes API (children) → Per-origin guides
  • Reduced documentation duplication by having alert/change APIs reference the parent for authentication and error codes
  • Preserved all existing integration content while improving discoverability through better organization

https://claude.ai/code/session_017jWTUJW4HMfCYk3AX3DZ84

Move the webhooks documentation tree from
`configuration/exporting/send-events*` to `configuration/webhooks/*` so
the URL matches the underlying endpoint. The Send Events API page is
now the parent and links to two children:

- Send Alerts API (`webhooks/send-alerts-api.rst`) hosts the 14
  existing alert origin pages, now under `webhooks/alerts/`.
- Send Changes API (`webhooks/send-changes-api.rst`) is new and
  documents the LaunchDarkly, Argo CD, and GitHub change webhooks
  under `webhooks/changes/`.

The Send Events API page itself mentions both alerts and changes and
points at the relevant child. The two ``incident`` references were
dropped from user-facing copy since we don't support that type yet.

https://claude.ai/code/session_017jWTUJW4HMfCYk3AX3DZ84
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Docker image ready for 3951d1f (built in 3m 40s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:3951d1f
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:3951d1f me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:3951d1f
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:3951d1f

Patch Helm values in one line:

helm upgrade --install robusta robusta/robusta \
  --reuse-values \
  --set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:3951d1f

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Walkthrough

This PR restructures Robusta's webhook documentation by relocating the unified "Send Events API" documentation from configuration/exporting/ to configuration/webhooks/, adding separate specialized containers for "Send Alerts API" and "Send Changes API", and introducing new integration guides for Argo CD, GitHub, and LaunchDarkly change webhooks.

Changes

Webhook API Documentation Reorganization

Layer / File(s) Summary
Unified Send Events API hub
docs/configuration/webhooks/send-events-api.rst, docs/index.rst
The foundational "Send Events API" documentation is moved from exporting/ to webhooks/ and serves as the parent hub defining endpoint format, query parameters (type, origin, account_id), Bearer token authentication, success/error responses, and cross-links to specialized alert and change APIs. The index toctree is updated to reference the new location.
Alert and Change API containers
docs/configuration/webhooks/send-alerts-api.rst, docs/configuration/webhooks/send-changes-api.rst
"Send Alerts API" and "Send Changes API" pages are introduced as separate containers, each referencing the shared Send Events API for auth/params/errors and providing integration grids/toctrees linking to their respective monitoring system and change source subpages.
Index grid reorganization
docs/configuration/index.rst
The "Programmatic Integration" grid is refreshed to feature "Send Events API" as the recommended primary option while preserving legacy cards, and the toctree adds webhooks/send-events-api.

Change Event Integration Guides

Layer / File(s) Summary
Argo CD, GitHub, and LaunchDarkly change webhooks
docs/configuration/webhooks/changes/argocd.rst, docs/configuration/webhooks/changes/github.rst, docs/configuration/webhooks/changes/launchdarkly.rst
Three new integration guides document how to configure webhooks for tracking deployment and configuration changes. Each covers prerequisites (account/API key), webhook URL/payload format, platform-specific setup steps (Argo CD ConfigMap, GitHub repo settings, LaunchDarkly UI), expected Robusta outputs (configuration_change issues with diff evidence), and testing instructions.

Sequence Diagram(s)

No sequence diagrams generated; this PR is primarily documentation restructuring without functional code changes or multi-component interactions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • robusta-dev/robusta#2076: Directly related—that PR adds the Send Events API docs that this PR relocates from exporting/ to webhooks/.
  • robusta-dev/robusta#1942: Both PRs expand LaunchDarkly integration documentation and navigation, though this PR focuses on the webhook-based change integration path.
  • robusta-dev/robusta#2011: Both PRs center on Robusta's webhook ingestion and API key authentication configuration for alert and change forwarding.

Suggested reviewers

  • RoiGlinik
  • Avi-Robusta
  • moshemorad
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: reorganizing webhook documentation into a new directory structure under webhooks.
Description check ✅ Passed The description provides detailed, well-organized information about the restructuring, new documentation additions, and navigation updates that align with the changeset.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/add-webhook-changes-support-28CHR

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.

@naomi-robusta naomi-robusta changed the title Reorganize webhook documentation under new webhooks directory ROB-3785 Reorganize webhook documentation under new webhooks directory May 14, 2026
Copy link
Copy Markdown

@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/configuration/webhooks/changes/github.rst`:
- Around line 20-46: The doc currently instructs users to complete webhook steps
1–7 (including "Save") before showing the required token parameter, which causes
them to save an unauthenticated webhook; move the explanation/example that
includes the token (the code-block containing &token=<ROBUSTA_API_KEY> and the
phrase "Pass the Robusta API key on the URL instead") so it appears before or
within step 2 (the "Payload URL" instruction) and update the initial example URL
shown at the top to include &token=<ROBUSTA_API_KEY>; ensure references to
"Payload URL" and the token parameter remain clear so users include the token
when they paste the URL.
🪄 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: 72eba4f8-f0fc-4fa6-bb2f-ddb824cf88e8

📥 Commits

Reviewing files that changed from the base of the PR and between b910105 and 10beeda.

📒 Files selected for processing (23)
  • docs/configuration/exporting/send-events-api.rst
  • docs/configuration/index.rst
  • docs/configuration/webhooks/alerts/alertmanager.rst
  • docs/configuration/webhooks/alerts/aws-cloudwatch.rst
  • docs/configuration/webhooks/alerts/azure-monitor.rst
  • docs/configuration/webhooks/alerts/datadog.rst
  • docs/configuration/webhooks/alerts/dynatrace.rst
  • docs/configuration/webhooks/alerts/gcp-monitoring.rst
  • docs/configuration/webhooks/alerts/grafana.rst
  • docs/configuration/webhooks/alerts/nagios.rst
  • docs/configuration/webhooks/alerts/newrelic.rst
  • docs/configuration/webhooks/alerts/opsgenie.rst
  • docs/configuration/webhooks/alerts/pagerduty.rst
  • docs/configuration/webhooks/alerts/sentry.rst
  • docs/configuration/webhooks/alerts/solarwinds.rst
  • docs/configuration/webhooks/alerts/splunk.rst
  • docs/configuration/webhooks/changes/argocd.rst
  • docs/configuration/webhooks/changes/github.rst
  • docs/configuration/webhooks/changes/launchdarkly.rst
  • docs/configuration/webhooks/send-alerts-api.rst
  • docs/configuration/webhooks/send-changes-api.rst
  • docs/configuration/webhooks/send-events-api.rst
  • docs/index.rst
💤 Files with no reviewable changes (1)
  • docs/configuration/exporting/send-events-api.rst

Comment thread docs/configuration/webhooks/changes/github.rst
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.

2 participants