Skip to content

Commit b96f8cc

Browse files
authored
DOCS-1303 - Add playbooks to incidents with API (#6131)
* DOCS-1303 - Add playbooks to incidents with API * Remove release note
1 parent 9b5e6f7 commit b96f8cc

File tree

3 files changed

+39
-14
lines changed

3 files changed

+39
-14
lines changed

docs/cloud-soar/automation.md

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,44 @@ The following sections describe automation features only used in Cloud SOAR.
2626

2727
## Run playbooks in Cloud SOAR
2828

29-
In Cloud SOAR, playbooks are run from [incidents](/docs/cloud-soar/incidents-triage/#incidents). To run playbooks in Cloud SOAR, perform the following steps:
30-
1. [Create a playbook](/docs/platform-services/automation-service/playbooks/create-playbooks/#create-a-new-playbook) to use in incident response. When you create the playbook, do the following:
31-
1. Click the **Edit** icon on the **Start** node:<br/><img src={useBaseUrl('img/platform-services/automation-service/start-node.png')} alt="Start node" style={{border:'1px solid gray'}} width="100"/>
32-
1. Ensure that the **Add one or more params as a playbook input** field is left blank: <br/><img src={useBaseUrl('img/platform-services/automation-service/edit-start-node-input.png')} alt="Edit node dialog" style={{border:'1px solid gray'}} width="500"/><br/>Do *not* click the field to show the dropdown menu: <br/><img src={useBaseUrl('img/platform-services/automation-service/start-node-parameters.png')} alt="Types of start node parameters" style={{border:'1px solid gray'}} width="400"/><br/>The other values in the field are used for automation outside of Cloud SOAR:
33-
* **Insight** and **Entity** are for launching a playbook from a Cloud SIEM automation.
34-
* **Alert** is for launching a playbook from a monitor.
35-
* **Parse from JSON** is for launching a playbook from another playbook.
36-
1. Proceed to create the playbook as needed.
37-
1. [Create an incident template](#create-a-new-incident-template) to be assigned to incidents. When you create the template, add the playbook to the template and select **Autorun** to run the playbook when the incident is created, or deselect if you want to manually run the playbook from the incident.<br/><img src={useBaseUrl('img/cloud-soar/new-incident-template-add-playbook.png')} alt="New template" style={{border: '1px solid gray'}} width="700"/>
38-
1. Monitor and run playbooks on [incidents](/docs/cloud-soar/incidents-triage/#incidents):
39-
* Within an incident, select **Operations > Playbooks** to see the playbooks assigned to the incident.
40-
* If playbooks haven't been assigned by an incident template, you can add playbooks by clicking the **+** button.
41-
* To manually run a playbook for the incident, click the **Run** button at the bottom of the screen.<br/><img src={useBaseUrl('img/cloud-soar/playbook-on-incident.png')} alt="Playbook on an incident" style={{border: '1px solid gray'}} width="700"/>
29+
In Cloud SOAR, playbooks are run from [incidents](/docs/cloud-soar/incidents-triage/#incidents). This section describes how to create and run playbooks on incidents.
30+
31+
### Create a playbook to use for incidents
32+
33+
When you [create a playbook](/docs/platform-services/automation-service/playbooks/create-playbooks/#create-a-new-playbook) to use in incident response, do the following:
34+
1. Click the **Edit** icon on the **Start** node:<br/><img src={useBaseUrl('img/platform-services/automation-service/start-node.png')} alt="Start node" style={{border:'1px solid gray'}} width="100"/>
35+
1. Ensure that the **Add one or more params as a playbook input** field is left blank: <br/><img src={useBaseUrl('img/platform-services/automation-service/edit-start-node-input.png')} alt="Edit node dialog" style={{border:'1px solid gray'}} width="500"/><br/>Do *not* click the field to show the dropdown menu: <br/><img src={useBaseUrl('img/platform-services/automation-service/start-node-parameters.png')} alt="Types of start node parameters" style={{border:'1px solid gray'}} width="400"/><br/>The other values in the field are used for automation outside of Cloud SOAR:
36+
* **Insight** and **Entity** are for launching a playbook from a Cloud SIEM automation.
37+
* **Alert** is for launching a playbook from a monitor.
38+
* **Parse from JSON** is for launching a playbook from another playbook.
39+
1. Proceed to create the playbook as needed.
40+
41+
### Add a playbook to an incident template
42+
43+
1. [Create an incident template](#create-a-new-incident-template) to be assigned to incidents.
44+
1. When you create the template, add the playbook to the template and select **Autorun** to run the playbook when the incident is created, or deselect if you want to manually run the playbook from the incident.<br/><img src={useBaseUrl('img/cloud-soar/new-incident-template-add-playbook.png')} alt="New template" style={{border: '1px solid gray'}} width="700"/>
45+
46+
### Manually add a playbook to an incident
47+
48+
1. Open the [incident](/docs/cloud-soar/incidents-triage/#incidents) in Cloud SOAR.
49+
1. Select **Operations > Playbooks**.
50+
1. Click the **+** button to add the playbook.
51+
1. Click **List View** to see the playbooks attached to the incident.<br/><img src={useBaseUrl('img/cloud-soar/cloud-soar-add-playbook-to-incident.png')} alt="Manually add playbook" style={{border: '1px solid gray'}} width="700"/>
52+
53+
### Monitor and run playbooks on incidents
54+
55+
To monitor and run playbooks on [incidents](/docs/cloud-soar/incidents-triage/#incidents):
56+
1. Within an incident, select **Operations > Playbooks** to see the playbooks assigned to the incident.
57+
1. If playbooks haven't been assigned by an incident template, you can add playbooks by clicking the **+** button.
58+
1. To manually run a playbook for the incident, click the **Run** button at the bottom of the screen.<br/><img src={useBaseUrl('img/cloud-soar/playbook-on-incident.png')} alt="Playbook on an incident" style={{border: '1px solid gray'}} width="700"/>
59+
60+
### Add a playbook to an incident with the API
61+
62+
You can attach playbooks to an incident with the API. This lets you automate incident workflows without having to use the UI, and enables integration with external systems.
63+
64+
To attach one or more playbooks to an [incident](/docs/cloud-soar/incidents-triage/#incidents), with an option to auto-run them after attachment, use the [incidents_runbook_create](https://api.sumologic.com/docs/csoar/#operation/incidents_runbook_create) API. To retrieve all playbooks attached to a specific incident, use the [incidents_runbook_retrieve](https://api.sumologic.com/docs/csoar/#operation/incidents_runbook_retrieve) API.
65+
66+
For more information about how to use APIs, see [Cloud SOAR APIs](/docs/api/cloud-soar/).
4267

4368
## Incident templates
4469

docs/cloud-soar/incidents-triage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ All the information related to the ongoing incident is visible in one place in
269269

270270
#### Playbooks
271271

272-
Any playbook that has been applied to an incident can be found under the **Playbooks** section. You can quickly view and make any necessary adjustments to the incident's playbooks, as well as add any additional playbooks that may be required during an incident's investigation.
272+
Any playbook that has been applied to an incident can be found under the **Playbooks** section. You can quickly view and make any necessary adjustments to the incident's playbooks, as well as add any additional playbooks that may be required during an incident's investigation. For more information, see [Run playbooks in Cloud SOAR](/docs/cloud-soar/automation/#run-playbooks-in-cloud-soar).
273273

274274
<img src={useBaseUrl('img/cloud-soar/operations-playbooks-tab.png')} alt="Playbooks displayed in the Playbooks tab" style={{border: '1px solid gray'}} width="700"/>
275275

150 KB
Loading

0 commit comments

Comments
 (0)