Alerts can be shared via a shareable URL (#3264)

Co-authored-by: Joe Peeples <[email protected]> Co-authored-by: Janeen Mikell Roberts <[email protected]> (cherry picked from commit 32bfbd9)
elastic · May 22, 2023 · f9eb284 · f9eb284
1 parent 760b30d
commit f9eb284
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/docs/detections/alerts-view-details.asciidoc b/docs/detections/alerts-view-details.asciidoc
@@ -4,7 +4,7 @@
 To inspect a detection alert, click the *View details* button from the Alerts table. The alert details flyout appears with several options to view alert data.
 
 [role="screenshot"]
-image::images/view-alert-details.png[View details button, 200]
+image::images/view-alert-details.png[View details button, 200] 
 
 The alert details flyout contains these informational tabs:
 
@@ -14,6 +14,12 @@ The alert details flyout contains these informational tabs:
 * *JSON*: The alert data in JSON format.
 * *Osquery Results*: Results from queries attached to rules display on the *Osquery Results* tab. <<add-osquery-response-action,Learn more.>>
 
+The **Share alert** link allows you to share alert details. Click it to copy a URL that you can paste into browsers, cases, messages, and more. We recommend doing this instead of copying the URL from your browser's address bar, which can cause inconsistent results if the Alerts page has filters or relative time ranges. 
+
+IMPORTANT: If you've enabled grouping on the Alerts page, the alert details flyout won't open until you expand the collapsed group. 
+
+NOTE: If you've configured the {kibana-ref}/settings.html#server-publicBaseUrl[`server.publicBaseUrl`] setting in the `kibana.yml` file, the shareable URL is also in the `kibana.alert.url` field. You can find the field by searching for `kibana.alert.url` on the *Table* tab.
+
 [role="screenshot"]
 image::images/alert-details-flyout.png[Alert details flyout, 90%]
 

diff --git a/docs/detections/images/alert-details-flyout.png b/docs/detections/images/alert-details-flyout.png
diff --git a/docs/reference/alert-schema.asciidoc b/docs/reference/alert-schema.asciidoc
@@ -156,5 +156,11 @@ Type: date
 Type: date
 |N/A | `kibana.alert.suppression.docs_count` | The number of suppressed alerts.
 
+Type: long
+
+|N/A | `kibana.alert.url` a| The shareable URL for the alert.
+
+NOTE: This field only appears if you've set the {kibana-ref}/settings.html#server-publicBaseUrl[`server.publicBaseUrl`] configuration setting in the `kibana.yml` file. 
+
 Type: long
 |==============================================