Skip to content

docs(integrations): document the Kibana webhook body and workload matching - #869

Open
mayankpande88 wants to merge 1 commit into
mainfrom
docs/elasticsearch-webhook-connector-body
Open

mayankpande88 wants to merge 1 commit into
mainfrom
docs/elasticsearch-webhook-connector-body

Conversation

@mayankpande88

@mayankpande88 mayankpande88 commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Description

Summary

The Elasticsearch / Kibana webhook page told readers to point a connector at the URL but never gave the JSON body a Kibana webhook action has to send. Kibana has no default body, so every reader had to guess one.

The page now gives:

  • the body for the firing action and for the recovered action
  • a table of what each field does
  • how the rule's group values are matched to a workload, and when a namespace or workload label is needed
  • why a link back to Kibana only appears when server.publicBaseUrl is set

The matching behavior described here ships in an upcoming server release; the page says what older releases do.

Type of change

  • Update to existing documentation

How Has This Been Tested?

Open the Elasticsearch / Kibana Webhook page in a local build of the site: Step 2 shows the JSON body, the field table and the workload matching rules, and both notes render.

Checklist

  • I ran npm run build locally and the site builds without errors
  • I ran npm run lint locally and lint passes
  • Internal links work; new external links open the correct page
  • My commits are signed off (DCO — git commit -s)
  • I read CONTRIBUTING.md

Local e2e: n/a — documentation only; the site build and lint pass.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request significantly expands the documentation for the Elasticsearch/Kibana webhook integration, adding detailed steps for creating the connector, configuring rule actions with a JSON payload, and explaining workload resolution. It also updates the troubleshooting table with more specific scenarios. The feedback suggests correcting the spelling of 'behaviour' to 'behavior' to maintain consistent US English throughout the documentation.

Comment thread doc-server/docs/integrations/Webhooks/elasticsearch_webhook.md Outdated
…ching

The Elasticsearch / Kibana webhook page told readers to point a connector at
the URL but never gave the JSON body a Kibana webhook action has to send.
Kibana has no default body, so every reader had to guess one.

The page now gives the body for the firing and the recovered action, a table
of what each field does, how the rule's group values are matched to a
workload, when a namespace or workload label is needed, and why a link only
appears when server.publicBaseUrl is set.

Signed-off-by: mayankpande88 <[email protected]>
@mayankpande88
mayankpande88 force-pushed the docs/elasticsearch-webhook-connector-body branch from df92d2c to 4e78620 Compare October 7, 2026 14:48
@mayankpande88
mayankpande88 marked this pull request as ready for review October 8, 2026 04:38
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