Skip to content

Commit 5b87931

Browse files
jpipkin1kimsauce
andauthored
DOCS-91 - Playbook payloads (#4650)
* First draft * Second draft * cid redirect * Corrections --------- Co-authored-by: Kim Pohas <[email protected]>
1 parent 3420bd5 commit 5b87931

16 files changed

+446
-146
lines changed

cid-redirects.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2727,7 +2727,7 @@
27272727
"/cid/21037": "/docs/integrations/google/cloud-vpn",
27282728
"/cid/21038": "/docs/integrations/containers-orchestration/vmware-tanzu-application-service",
27292729
"/cid/10999": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source",
2730-
"/cid/11000": "/docs/alerts/monitors/automation-payload-variables",
2730+
"/cid/11000": "/docs/platform-services/automation-service/automation-service-playbooks",
27312731
"/Cloud_SIEM_Enterprise": "/docs/cse",
27322732
"/Cloud_SIEM_Enterprise/Administration": "/docs/cse/administration",
27332733
"/Cloud_SIEM_Enterprise/Administration/Cloud_SIEM_Enterprise_Feature_Update_(2022)": "/docs/cse/administration",
@@ -3412,6 +3412,7 @@
34123412
"/Visualizations-and-Alerts/Alerts/02-Schedule-a-Search": "/docs/alerts/scheduled-searches",
34133413
"/Visualizations-and-Alerts/Alerts/Alert_Grouping": "/docs/alerts/monitors/alert-grouping",
34143414
"/Visualizations-and-Alerts/Alerts/Alert_Variables": "/docs/alerts/monitors/alert-variables",
3415+
"/docs/alerts/monitors/automation-payload-variables": "/docs/platform-services/automation-service/automation-service-playbooks",
34153416
"/Visualizations-and-Alerts/Alerts/Monitors": "/docs/alerts/monitors",
34163417
"/Visualizations-and-Alerts/Alerts/Monitors/About_Monitors": "/docs/alerts/monitors/overview",
34173418
"/Visualizations-and-Alerts/Alerts/Monitors/Monitor_FAQ": "/docs/alerts/monitors/monitor-faq",

docs/alerts/monitors/automation-payload-variables.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

docs/alerts/monitors/index.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,4 @@ In this section, we'll introduce the following concepts:
7878
<p>Learn how to use Automation Service playbooks with monitors.</p>
7979
</div>
8080
</div>
81-
<div className="box smallbox card">
82-
<div className="container">
83-
<a href="/docs/alerts/monitors/automation-payload-variables"><img src={useBaseUrl('img/icons/operations/monitor-and-visualize.png')} alt="icon" width="40"/><h4>Automation Payload Variables</h4></a>
84-
<p>Learn details about variables passed from a monitor to a playbook in the Automation Service.</p>
85-
</div>
86-
</div>
8781
</div>

docs/alerts/monitors/use-playbooks-with-monitors.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Some integrations that have useful actions for monitors include:
155155

156156
### Pass custom fields from a monitor to playbooks
157157

158-
Results from an alert query are passed to a playbook through the [automation payload](/docs/alerts/monitors/automation-payload-variables/). The variables from the payload can be used as inputs for different nodes in the playbook after they are defined as parameters in the start node.
158+
Results from an alert query are passed to a playbook through the [alert payload](/docs/platform-services/automation-service/automation-service-playbooks/#alert-payload). The variables from the payload can be used as inputs for different nodes in the playbook after they are defined as parameters in the start node.
159159

160160
:::note
161161
You must use [alert grouping](/docs/alerts/monitors/alert-grouping/) in the monitor configuration to pass fields from the query to the playbook.
@@ -165,12 +165,12 @@ You must use [alert grouping](/docs/alerts/monitors/alert-grouping/) in the moni
165165

166166
1. Click **Edit** on the Start Node.
167167
1. Select **Alert** from the dropdown. <br/><img src={useBaseUrl('img/alerts/parse_from_alert.png')} alt="Payload parameters from an alert" style={{border: '1px solid gray'}} width="700" />
168-
1. The parameters from the default [automation payload variables](/docs/alerts/monitors/automation-payload-variables/) will be defined, along with some placeholders for custom fields that may be passed from the alert query. To reference a field passed from the alert query, use `customPlaceholderMap[].FIELDNAME`.
168+
1. The parameters from the default [alert payload variables](/docs/platform-services/automation-service/automation-service-playbooks/#alert-payload) will be defined, along with some placeholders for custom fields that may be passed from the alert query. To reference a field passed from the alert query, use `customPlaceholderMap[].FIELDNAME`.
169169

170-
#### Configure Parameters from a JSON Payload
170+
#### Configure parameters from a JSON payload
171171

172172
1. Click **Edit** on the Start Node.
173173
1. Select **Parse from Json** from the dropdown. <br/><img src={useBaseUrl('img/alerts/parse_from_json.png')} alt="Payload parameters from a Json payload" style={{border: '1px solid gray'}} width="700" />
174-
1. Copy the payload from a previously triggered automation. You can view the playbook payload of a previously triggered alert by following the steps [here](/docs/alerts/monitors/automation-payload-variables/#view-playbook-payload).
174+
1. Copy the payload from a previously triggered automation. You can view the playbook payload of a previously triggered alert by following the steps [here](/docs/platform-services/automation-service/automation-service-playbooks/#alert-payload).
175175
1. Paste the payload into the **Enter Json payload** text box and click **Parse**. The fields from the payload will be auto parsed to parameters. <br/><img src={useBaseUrl('img/alerts/parse_from_json_payload.png')} alt="Parse from Json payload" style={{border: '1px solid gray'}} width="700" />
176176
1. Add or remove parameters based on the playbook requirements and click **Update**. <br/><img src={useBaseUrl('img/alerts/parse_from_json_parameters.png')} alt="Json Payload parameters" style={{border: '1px solid gray'}} width="700" />

0 commit comments

Comments
 (0)