Skip to content

Commit a72b71e

Browse files
authored
DOCS-1111 - Break up playbooks article (#5785)
* Break up playbooks article * Updates from Kim Pohas review
1 parent 311483e commit a72b71e

31 files changed

+995
-932
lines changed

blog-csoar/2024/12-31.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ This release contains several updates, including the introduction of new actions
448448

449449
#### Changes and Enhancements
450450
* Playbooks:
451-
* Enabled [playbook testing](/docs/platform-services/automation-service/automation-service-playbooks/#test-a-playbook). With this improvement it is now possible to test a playbook configuration before publishing it, using Insight, Incident or custom JSON as input.
451+
* Enabled [playbook testing](/docs/platform-services/automation-service/playbooks/troubleshoot-playbooks/#test-a-playbook). With this improvement it is now possible to test a playbook configuration before publishing it, using Insight, Incident or custom JSON as input.
452452
* Action configuration: Integration fields configuration now suggests default values, if present.
453453
* UserChoice, answer by Email: Fixed Authorizer usage from previous nodes.
454454
* AppCentral: Within the Integrations section, each integration card now contains a hyperlink to the related public documentation page [Integrations in App Central](/docs/platform-services/automation-service/app-central/integrations/).

blog-csoar/2025-02-06-application-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1717

1818
🚀 **New feature release: Autosave for playbooks**
1919

20-
We’re excited to introduce [autosave for playbooks](/docs/platform-services/automation-service/automation-service-playbooks/#autosave), a feature designed to make workflow changes seamless by automatically saving your progress as draft and preventing accidental data loss. Here's what's new:
20+
We’re excited to introduce [autosave for playbooks](/docs/platform-services/automation-service/playbooks/create-playbooks/#autosave), a feature designed to make workflow changes seamless by automatically saving your progress as draft and preventing accidental data loss. Here's what's new:
2121
* Playbooks now automatically save your changes, including node updates, connections, and position adjustments.
2222
* Multiple changes made in quick succession are saved together to improve performance.
2323
* Visual indicators display the saving status whether in progress, successfully saved, or failed.

blog-csoar/2025-02-24-application-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ When selecting an array variable in the text area, you will have two options:
2525

2626
If the iterate option is selected, an icon will appear in front of the variable inside the text area to indicate that iteration is enabled. The action will then execute as many times as there are elements in the array.
2727

28-
[Learn more](/docs/platform-services/automation-service/automation-service-playbooks/#arrays-in-text-areas).
28+
[Learn more](/docs/platform-services/automation-service/playbooks/arrays-in-playbooks/).

blog-csoar/2025-06-03-application-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ What's new:
2525
* By default, playbooks with any published version are set to enabled, while those that are draft-only or have been deleted remain disabled.
2626
* Audit logs are generated whenever playbooks are enabled or disabled manually.
2727

28-
For more information, see [Enable or disable playbooks](/docs/platform-services/automation-service/automation-service-playbooks/#enable-or-disable-playbooks).
28+
For more information, see [Enable or disable playbooks](/docs/platform-services/automation-service/playbooks/create-playbooks/#enable-or-disable-playbooks).
2929

3030
#### Integrations
3131

blog-csoar/2025-09-10-application-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ What's new:
1919
* Available on action, condition, user choice, and task nodes. (It is not available on filter or nested playbook nodes.)
2020
* Testing nodes counts against your [action limit](/docs/platform-services/automation-service/about-automation-service/#actions-limit) quota.
2121

22-
For more information, see [Test nodes in a playbook](/docs/platform-services/automation-service/automation-service-playbooks/#test-nodes-in-a-playbook).
22+
For more information, see [Test nodes in a playbook](/docs/platform-services/automation-service/playbooks/troubleshoot-playbooks/#test-nodes-in-a-playbook).

cid-redirects.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1883,7 +1883,7 @@
18831883
"/cid/1156": "/docs/get-started/apps-integrations",
18841884
"/cid/1160": "/docs/send-data/installed-collectors/sources/streaming-metrics-source",
18851885
"/cid/11987": "/docs/manage/partitions/data-tiers",
1886-
"/cid/12001": "/docs/platform-services/automation-service/automation-service-playbooks",
1886+
"/cid/12001": "/docs/platform-services/automation-service/playbooks",
18871887
"/cid/123456": "/docs/get-started/apps-integrations",
18881888
"/cid/12809": "/docs/integrations/security-threat-detection/sailpoint",
18891889
"/cid/129210839": "/docs/alerts/webhook-connections/servicenow",
@@ -2920,7 +2920,7 @@
29202920
"/cid/21040": "/docs/manage/manage-subscription/create-and-manage-orgs/create-manage-orgs-service-providers",
29212921
"/cid/21038": "/docs/integrations/containers-orchestration/vmware-tanzu-application-service",
29222922
"/cid/10999": "/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source",
2923-
"/cid/11000": "/docs/platform-services/automation-service/automation-service-playbooks",
2923+
"/cid/11000": "/docs/platform-services/automation-service/playbooks",
29242924
"/cid/1105": "/docs/integrations/cloud-security-monitoring-analytics/aws-security-hub-ocsf",
29252925
"/cid/1106": "/docs/integrations/sumo-apps/opentelemetry-collector-insights",
29262926
"/cid/1107": "/docs/integrations/saas-cloud/aws-iam-users",
@@ -3675,7 +3675,7 @@
36753675
"/Visualizations-and-Alerts/Alerts/02-Schedule-a-Search": "/docs/alerts/scheduled-searches",
36763676
"/Visualizations-and-Alerts/Alerts/Alert_Grouping": "/docs/alerts/monitors/alert-grouping",
36773677
"/Visualizations-and-Alerts/Alerts/Alert_Variables": "/docs/alerts/monitors/alert-variables",
3678-
"/docs/alerts/monitors/automation-payload-variables": "/docs/platform-services/automation-service/automation-service-playbooks",
3678+
"/docs/alerts/monitors/automation-payload-variables": "/docs/platform-services/automation-service/playbooks/playbook-payloads",
36793679
"/Visualizations-and-Alerts/Alerts/Monitors": "/docs/alerts/monitors",
36803680
"/Visualizations-and-Alerts/Alerts/Monitors/About_Monitors": "/docs/alerts/monitors/overview",
36813681
"/Visualizations-and-Alerts/Alerts/Monitors/Monitor_FAQ": "/docs/alerts/monitors/monitor-faq",
@@ -4394,7 +4394,8 @@
43944394
"/docs/cse/automation-service/automation-service-automations": "/docs/cse/automation/automations-in-cloud-siem",
43954395
"/docs/cse/automation-service/automation-service-examples": "/docs/cse/automation/cloud-siem-automation-examples",
43964396
"/docs/cse/automation-service/automation-service-app-central": "/docs/platform-services/automation-service/automation-service-app-central",
4397-
"/docs/cse/automation-service/automation-service-playbooks": "/docs/platform-services/automation-service/automation-service-playbooks",
4397+
"/docs/cse/automation-service/automation-service-playbooks": "/docs/platform-services/automation-service/playbooks",
4398+
"/docs/platform-services/automation-service/automation-service-playbooks": "/docs/platform-services/automation-service/playbooks",
43984399
"/docs/cse/automation-service/automation-service-integrations": "/docs/platform-services/automation-service/automation-service-integrations",
43994400
"/docs/cse/automation-service/automation-service-bridge": "/docs/platform-services/automation-service/automation-service-bridge",
44004401
"/docs/cloud-soar/cloud-soar-bridge": "/docs/platform-services/automation-service/automation-service-bridge",

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Learn how to use Automation Service playbooks with monitors.
88
import useBaseUrl from '@docusaurus/useBaseUrl';
99
import Iframe from 'react-iframe';
1010

11-
This article describes how to configure automated playbooks in monitors. An *automated playbook* is a [playbook in the Automation Service](/docs/platform-services/automation-service/automation-service-playbooks/), and is a predefined set of actions and conditional statements that run in an automated workflow to respond to an event. For example, suppose that a monitor detects suspicious behavior that could indicate a security problem. When the monitor sends the alert, it could also run an automated playbook to respond to the event.
11+
This article describes how to configure automated playbooks in monitors. An *automated playbook* is a [playbook in the Automation Service](/docs/platform-services/automation-service/playbooks), and is a predefined set of actions and conditional statements that run in an automated workflow to respond to an event. For example, suppose that a monitor detects suspicious behavior that could indicate a security problem. When the monitor sends the alert, it could also run an automated playbook to respond to the event.
1212

1313
To add an automated playbook to a monitor, see [Add an automated playbook to a monitor](#add-an-automated-playbook-to-a-monitor) below.
1414

@@ -49,7 +49,7 @@ For more information, see [About the Automation Service](/docs/platform-services
4949

5050
1. [Open the **New Monitor** window](/docs/alerts/monitors/create-monitor/#open-the-new-monitor-window).
5151
1. Perform [Step 1](/docs/alerts/monitors/create-monitor/#step-1-set-trigger-conditions), [Step 2](/docs/alerts/monitors/create-monitor/#step-2-advanced-settings-optional), and [Step 3](/docs/alerts/monitors/create-monitor/#step-3-notifications-optional) in the **New Monitor** window.
52-
1. In [Step 4: Playbook](/docs/alerts/monitors/create-monitor/#step-4-playbook-optional), click the field under **Automated Playbooks** to select a [playbook in the Automation Service](/docs/platform-services/automation-service/automation-service-playbooks/) to run when an alert is fired. <br/><img src={useBaseUrl('img/alerts/monitors/monitor-playbooks-ui.png')} alt="Add a playbook to a monitor" style={{border: '1px solid gray'}} width="800" />
52+
1. In [Step 4: Playbook](/docs/alerts/monitors/create-monitor/#step-4-playbook-optional), click the field under **Automated Playbooks** to select a [playbook in the Automation Service](/docs/platform-services/automation-service/playbooks/) to run when an alert is fired. <br/><img src={useBaseUrl('img/alerts/monitors/monitor-playbooks-ui.png')} alt="Add a playbook to a monitor" style={{border: '1px solid gray'}} width="800" />
5353
1. (Optional) Click **Manage Playbooks** to see playbooks in the Automation Service. From here you can view the playbook you selected above and look at its details in the Automation Service to determine if it is the one you want to run when the alert is triggered. You can also edit the playbook, or if you want, create a new playbook in the Automation Service to use in the monitor.
5454

5555
After you add playbooks to the monitor, when the monitor triggers an alert, the selected playbooks run automatically.
@@ -69,7 +69,7 @@ Once a monitor triggers an alert with one or more attached playbooks, you can vi
6969
| <img src={useBaseUrl('img/alerts/monitors/playbook-completed-icon.png')} alt="Completed icon" width="30" /> | Completed |
7070
| <img src={useBaseUrl('img/alerts/monitors/playbook-completed-with-errors-icon.png')} alt="Completed icon" width="30" /> | Completed with errors |
7171

72-
1. Click the playbook name to open the [playbook in the Automation Service](/docs/platform-services/automation-service/automation-service-playbooks/). <br/>The playbook shows the status of each action in the playbook that ran for the alert. For example, **Success** displays at the bottom of actions that have successfully completed, **Failed** for actions that did not complete, or **Waiting Owner** for actions that need user interaction. <br/><img src={useBaseUrl('img/alerts/monitors/playbook-in-automation-service.png')} alt="Playbook in the Automation Service" style={{border: '1px solid gray'}} width="800" />
72+
1. Click the playbook name to open the [playbook in the Automation Service](//docs/platform-services/automation-service/playbooks/). <br/>The playbook shows the status of each action in the playbook that ran for the alert. For example, **Success** displays at the bottom of actions that have successfully completed, **Failed** for actions that did not complete, or **Waiting Owner** for actions that need user interaction. <br/><img src={useBaseUrl('img/alerts/monitors/playbook-in-automation-service.png')} alt="Playbook in the Automation Service" style={{border: '1px solid gray'}} width="800" />
7373
1. Click an action to view more about its status. Status information opens in a box to the left. <br/>In the following example of an action whose status is **Waiting Owner**, an **Action Task** appears in the box that describes user interaction required to complete the task. <br/><img src={useBaseUrl('img/alerts/monitors/playbook-waiting-owner.png')} alt="Playbook awaiting user interaction" style={{border: '1px solid gray'}} width="800" />
7474
1. If you have an action marked as **Waiting Owner**, perform the steps needed to complete the **Action Task**. When done, click the appropriate button at the bottom of the **Waiting Owner** action box (**Approve**, **Approve & Close**, or **Reject**). The action completes, and the subsequent remaining actions in the playbook run.<br/><img src={useBaseUrl('img/alerts/monitors/playbook-complete-task.png')} alt="Playbook awaiting user interaction" style={{border: '1px solid gray'}} width="300" />
7575
1. Address any other actions in the playbook that need attention. For example, click and open any failed actions to see why they failed and to determine what you need to do to get them to complete successfully.
@@ -136,7 +136,7 @@ Sample playbooks to attach to monitors include:
136136

137137
### Create playbooks for monitors
138138

139-
To create a playbook so you can add it to a monitor, see [Create a new playbook](/docs/platform-services/automation-service/automation-service-playbooks/#create-a-new-playbook). As a best practice, whenever you want to create a new playbook, select an existing playbook to serve as the template for the new playbook and click the **Duplicate** button to copy it.
139+
To create a playbook so you can add it to a monitor, see [Create a new playbook](/docs/platform-services/automation-service/playbooks/create-playbooks/#create-a-new-playbook). As a best practice, whenever you want to create a new playbook, select an existing playbook to serve as the template for the new playbook and click the **Duplicate** button to copy it.
140140

141141
<img src={useBaseUrl('img/alerts/monitors/playbook-duplicate-button.png')} alt="Duplicate button" style={{border: '1px solid gray'}} width="300" />
142142

@@ -157,7 +157,7 @@ Some integrations that have useful actions for monitors include:
157157

158158
### Pass custom fields from a monitor to playbooks
159159

160-
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.
160+
Results from an alert query are passed to a playbook through the [alert payload](/docs/platform-services/automation-service/playbooks/playbook-payloads/#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.
161161

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

168168
1. Click **Edit** on the Start Node.
169169
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" />
170-
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`.
170+
1. The parameters from the default [alert payload variables](/docs/platform-services/automation-service/playbooks/playbook-payloads/#alert-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`.
171171

172172
#### Configure parameters from a JSON payload
173173

174174
1. Click **Edit** on the Start Node.
175175
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" />
176-
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).
176+
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/playbooks/playbook-payloads/#view-an-alert-payload).
177177
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" />
178178
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)