Skip to content

ROB-3902 Add Rootly webhook integration documentation#2091

Merged
naomi-robusta merged 2 commits into
masterfrom
claude/blissful-galileo-efluB
May 28, 2026
Merged

ROB-3902 Add Rootly webhook integration documentation#2091
naomi-robusta merged 2 commits into
masterfrom
claude/blissful-galileo-efluB

Conversation

@naomi-robusta
Copy link
Copy Markdown
Contributor

Summary

This PR adds documentation for integrating Rootly alert lifecycle events with Robusta via webhook forwarding.

Changes

  • New documentation file: docs/configuration/exporting/send-events/rootly.rst

    • Comprehensive guide for setting up Rootly webhook integration
    • Prerequisites and required credentials
    • Step-by-step configuration instructions for Rootly
    • Webhook URL format and payload handling details
    • Verification steps for testing the integration
  • Updated index: docs/configuration/exporting/send-events-api.rst

    • Added Rootly to the toctree navigation
    • Added Rootly grid card to the "Incident Management" section for discoverability

Implementation Details

The documentation covers:

  • Required Robusta account credentials (account_id and API key)
  • Webhook URL construction with account_id parameter
  • Custom Authorization header setup with Bearer token
  • Supported Rootly alert events (alert.created, alert.resolved, alert.acknowledged)
  • Payload parsing logic including severity extraction from labels and deduplication via external_id
  • Verification through Robusta's delivery log and timeline

https://claude.ai/code/session_01WUQzXDiD8RUrpvmmdonPAZ

Adds send-events/rootly.rst with setup steps for the Rootly outgoing
webhook and wires it into the Send Events API toctree and the Incident
Management grid. Pairs with the relay rootly origin parser.

https://claude.ai/code/session_01WUQzXDiD8RUrpvmmdonPAZ
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2c858096-d2d4-442b-9cca-fe5228ae797e

📥 Commits

Reviewing files that changed from the base of the PR and between 954e99b and f8a118b.

📒 Files selected for processing (1)
  • docs/configuration/exporting/send-events/rootly.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/configuration/exporting/send-events/rootly.rst

Walkthrough

Documentation for Rootly integration is added to Robusta's Send Events API. A new Rootly guide covers webhook setup, authorization, event subscriptions, and payload field mapping. Navigation entries link the integration into the main Send Events API documentation.

Changes

Rootly Integration Documentation

Layer / File(s) Summary
Navigation and integration card
docs/configuration/exporting/send-events-api.rst
Toctree entry and Rootly card added to Incident Management integrations grid, linking to the new configuration guide.
Rootly webhook configuration guide
docs/configuration/exporting/send-events/rootly.rst
New page documents prerequisites, webhook URL construction with account_id, Rootly setup with Bearer token authorization and alert event subscriptions, payload field interpretation (severity, timestamps, deduplication via external_id), and verification via delivery logs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • robusta-dev/robusta#1930: Adds webhook-based integration docs for forwarding alerts to Robusta, similar outgoing-webhook pattern and payload guidance.
  • robusta-dev/robusta#2076: Modifies the Send Events API documentation structure and adds per-integration pages, related to the same docs area.

Suggested reviewers

  • RoiGlinik
  • moshemorad
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding Rootly webhook integration documentation. It matches the file additions and index updates in the changeset.
Description check ✅ Passed The description is well-related to the changeset, providing a clear summary of changes, listing the new documentation file and updated index file, and detailing implementation specifics about webhook setup, configuration, and verification.
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/blissful-galileo-efluB

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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 28, 2026

Docker image ready for 9fcfc06 (built in 35s)

⚠️ 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:9fcfc06
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:9fcfc06 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:9fcfc06
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:9fcfc06

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:9fcfc06

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@naomi-robusta naomi-robusta changed the title Add Rootly webhook integration documentation ROB-3902 Add Rootly webhook integration documentation May 28, 2026
Rootly's public docs only confirm alert.created as a webhook event type.
The previous wording told customers to subscribe to alert.resolved and
alert.acknowledged as if those were documented; rework the step to
recommend alert.created plus whatever the Rootly UI exposes, and clarify
that resolution is driven by the alert object's ended_at field.

https://claude.ai/code/session_01WUQzXDiD8RUrpvmmdonPAZ
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Actionable comments posted: 0

@naomi-robusta naomi-robusta enabled auto-merge (squash) May 28, 2026 11:25
@naomi-robusta naomi-robusta merged commit ca01bb7 into master May 28, 2026
7 checks passed
@naomi-robusta naomi-robusta deleted the claude/blissful-galileo-efluB branch May 28, 2026 11:27
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