ROB-463 Document optional cluster parameter in Send Events API

[naomi-robusta]

Summary

Added documentation for the optional cluster query parameter in the Send Events API endpoint.

Changes

• Added cluster parameter documentation to the Query Parameters table in the Send Events API configuration guide
• Documented the parameter's behavior:
  • When provided, it overrides any cluster found in the alert payload
  • Used for alert investigation routing
  • When omitted, the cluster is taken from the payload if present, otherwise defaults to the external cluster
  • Useful for monitoring systems that cannot add cluster labels to alerts themselves

Details

This documentation clarifies an existing API capability, helping users understand how to properly route alerts from external monitoring systems that lack native cluster labeling support.

https://claude.ai/code/session_01Ru3h6bxtTvy7H9XViGKgqW

[github-actions]

✅ Docker image ready for d6a5ecb (built in 3m 29s)

• us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:d6a5ecb

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

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:d6a5ecb

[coderabbitai]

Walkthrough

The Send Events API documentation adds a cluster query parameter entry to the webhook endpoint's Query Parameters table, describing override behavior relative to the alert payload and the external cluster fallback.

Changes

Send Events API Docs

Layer / File(s)	Summary
cluster query parameter docs/configuration/exporting/send-events-api.rst	Adds a cluster query parameter row documenting that it overrides the payload cluster, falls back to external if absent, and notes when to use it.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is directly about adding documentation for the optional cluster query parameter and its behavior.
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.
Title check	✅ Passed	The title clearly describes the main documentation change: adding the optional cluster parameter to the Send Events API.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/webhook-cluster-param-qyre17

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}