--- id: automation title: Cloud SOAR Automation sidebar_label: Automation description: Configuration tools for Cloud SOAR automation and orchestration features. slug: /help/docs/cloud-soar/automation/ canonical: https://www.sumologic.com/help/docs/cloud-soar/automation/ --- import Iframe from 'react-iframe'; import useBaseUrl from '@docusaurus/useBaseUrl'; The **Automation** section contains configuration tools for Cloud SOAR's automation and orchestration features. [**New UI**](/docs/get-started/sumo-logic-ui/). To access Automation, in the main Sumo Logic menu select **Automation**. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). To access Automation, click the gear icon Settings menu icon in the top right and select **Automation**. Because Cloud SOAR provides automation functionality to the [Automation Service](/docs/platform-services/automation-service/), many features are identical between Cloud SOAR and the Automation Service. Therefore, for information about the following Cloud SOAR features, see the Automation Service articles: * [App Central](/docs/platform-services/automation-service/app-central/) * [Integrations](/docs/platform-services/automation-service/automation-service-integrations/) * [Automation Bridge](/docs/platform-services/automation-service/automation-service-bridge) * [Open Integration Framework](/docs/platform-services/automation-service/integration-framework/) * [Audit Logging for the Automation Service and Cloud SOAR](/docs/platform-services/automation-service/automation-service-audit-logging) * [Playbooks](/docs/platform-services/automation-service/playbooks/). (For information specific to running playbooks in Cloud SOAR, see [Run playbooks in Cloud SOAR](#run-playbooks-in-cloud-soar) below.) The following sections describe automation features only used in Cloud SOAR. ## Run playbooks in Cloud SOAR 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. ### Create a playbook to use for incidents 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: 1. Click the **Edit** icon on the **Start** node:
Start node 1. Ensure that the **Add one or more params as a playbook input** field is left blank:
Edit node dialog
Do *not* click the field to show the dropdown menu:
Types of start node parameters
The other values in the field are used for automation outside of Cloud SOAR: * **Insight** and **Entity** are for launching a playbook from a Cloud SIEM automation. * **Alert** is for launching a playbook from a monitor. * **Parse from JSON** is for launching a playbook from another playbook. 1. Proceed to create the playbook as needed. ### Add a playbook to an incident template 1. [Create an incident template](#create-a-new-incident-template) to be assigned to incidents. 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.
New template ### Manually add a playbook to an incident 1. Open the [incident](/docs/cloud-soar/incidents-triage/#incidents) in Cloud SOAR. 1. Select **Operations > Playbooks**. 1. Click the **+** button to add the playbook. 1. Click **List View** to see the playbooks attached to the incident.
Manually add playbook ### Monitor and run playbooks on incidents To monitor and run playbooks on [incidents](/docs/cloud-soar/incidents-triage/#incidents): 1. Within an incident, select **Operations > Playbooks** to see the playbooks assigned to the incident. 1. If playbooks have not been assigned by an incident template, you can add playbooks by clicking the **+** button. 1. To manually run a playbook for the incident, click the **Run** button at the bottom of the screen.
Playbook on an incident ### Add a playbook to an incident with the API You can attach playbooks to an [incident](/docs/cloud-soar/incidents-triage/#incidents) with the API. This lets you automate incident workflows without having to use the UI, and enables integration with external systems. Use the following APIs: * [incidents_runbook_create](https://api.sumologic.com/docs/csoar/#operation/incidents_runbook_create). Attach one or more playbooks to an incident, with an option to auto-run them after attachment. * [incidents_runbook_retrieve](https://api.sumologic.com/docs/csoar/#operation/incidents_runbook_retrieve). Retrieve all playbooks attached to a specific incident. * [playbook_list_retrieve](https://api.sumologic.com/docs/csoar/#operation/playbook_list_retrieve). Get a list of all playbooks, including their IDs. Use the playbook IDs to run the above incident APIs. For more information about how to use APIs, see [Cloud SOAR APIs](/docs/api/cloud-soar/). ## Incident templates Incident templates define the way in which incidents will be created for a specific alert, incident type, or event. They allow you to define a certain number of incident attributes (for example, incident type, severity, assignment, and any other default or custom incident parameters) that will automatically be set each time an incident is generated, based on the template. This may include type, classification, incident assignment, playbooks, knowledge base articles, or any other incident attribute. Since rules are created for generating incidents based on syslog messages, email, SIEM integrations, or other data sources, it is the incident templates that will define how the initial incident will be created. ### Create a new incident template 1. [**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic menu select **Automation > Template**. You can also click the **Go To...** menu at the top of the screen and select **Template**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). Click the gear icon Settings menu icon in the top right, select **Automation**, and then select **Incident templates** in the left nav bar. 1. Click **+** to the left of **Template**.
Add template 1. Define the template:
Create incident template dialog 1. **Template name**. Enter a name that is easily identifiable and related to the activity it is developed for. 1. **Category**. Enter a category for this template. For example, suppose we're building a template for a Data Loss Prevention (DLP) incident. We might enter a category named **Data Theft**, but we can enter anything we want that will help us group incident templates in the future. You can customize this field to fit your environment, as well as all other fields in Cloud SOAR (see [Custom fields](/docs/cloud-soar/settings/#custom-fields)). 1. **Tags**. Enter any tags to further categorize or define the incident. You can use these tags later when searching for or correlating events. 1. Click **Incident** at the top of the dialog. 1. Define any incident parameters you want to set by default when an incident is creating using the template:
Create incident template dialog to define the incident type 1. Click **Apply**. The new template is displayed.
New template 1. Scroll down and enter the following: 1. **Incident details**. Click the **Edit** toggle to set up details for a specific incident type. 1. **Description**. Describe details of the template. 1. **Playbook**. Select the playbooks that should be automatically assigned to an incident. For each playbook, you can choose to have the playbook automatically execute immediately upon incident creation, or assigned and wait for manual execution. 1. **Investigators**. Select the investigators who should be automatically assigned to the incident. 1. **Notes**. Enter notes which should be created for the incident. 1. **Mapping**. Select the daemon field mapping for the template. ### Configure a webhook for Cloud SOAR You can configure a [webhook connection](/docs/alerts/webhook-connections/cloud-soar/) to allow you to send an alert from a scheduled search to Sumo Logic Cloud SOAR using an incident template. 1. [**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu select **Monitoring > Connections**. You can also click the **Go To...** menu at the top of the screen and select **Connections**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Connections**. 1. Click **+** and choose **Cloud SOAR** as the connection type. The **Create Cloud SOAR Connection** dialog is displayed.
New connection 1. Enter a **Name** and give an optional **Description** to the connection. 1. The **URL** field shows your [Sumo Logic API endpoint](/docs/api/about-apis/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security) followed by `/csoar/v3/incidents/`. For example, `https://api.us2.sumologic.com/api/csoar/v3/incidents/` 1. In **Authorization Header**, enter your basic authentication access information for the header. For example, `Basic :>`. For more information, see [Basic Access (Base64 encoded)](/docs/api/about-apis/getting-started#basic-access-base64-encoded). 1. Click **Save**. After save, the **Templates** dropdown shows a list of all incident templates by name configured in your Cloud SOAR environment. 1. Select a **Template**. 1. The default payload synchronizes with the selected template, and the **Alert Payload** field shows the associated `template_id` field automatically defined in the default payload. A `template_id` is required in the payload in order to configure the connection: ``` { "template_id":