Skip to content

Commit 39ee74a

Browse files
authored
Update cloud-soar.md
Need to update the steps in this page according to https://help.sumologic.com/docs/cloud-soar/automation/#configure-a-webhook-for-cloud-soar
1 parent 8c8ef3f commit 39ee74a

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

docs/alerts/webhook-connections/cloud-soar.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,44 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1616
* You'll need the **Manage connections** [role capability](/docs/manage/users-roles/roles/role-capabilities) to create webhook connections.
1717
:::
1818

19-
To create a webhook connection from Sumo Logic to Cloud SOAR:
19+
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.
2020

2121
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Connections**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Monitoring** select **Connections**. You can also click the **Go To...** menu at the top of the screen and select **Connections**.
22-
1. Click **+ Add** and choose **Cloud SOAR** as the connection type.<br/> <img src={useBaseUrl('img/connection-and-integration/SOAR-webhook-icon.png')} alt="SOAR webhook icon.png" width="200"/>
23-
1. Enter a **Name** and give an optional **Description** to the connection.
24-
1. The **URL** and **Authorization Header** are automatically defined by Sumo Logic. You should not edit these.
25-
1. The **Templates** dropdown shows a list of all incident templates, by name, configured in your Cloud SOAR environment.
26-
1. The default **Payload** synchronizes with the selected template and the associated `template_id` field is automatically defined in the default payload. A `template_id` is required in the payload in order to configure the connection. For details on variables you can use as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
27-
1. Click **Save**.
22+
1. Click **+** and choose **Cloud SOAR** as the connection type. The **Create Cloud SOAR Connection** dialog is displayed.<br/><img src={useBaseUrl('img/cloud-soar/CSOAR-connection1.png')} alt="New connection" style={{border: '1px solid gray'}} width="600"/>
23+
1. Enter a **Name** and give an optional **Description** to the connection.
24+
1. The **URL** field shows your [Sumo Logic API endpoint](/docs/api/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/`
25+
1. In **Authorization Header**, enter your basic authentication access information for the header. For example, `Basic <base64 encode <accessId>:<accessKey>>`. For more information, see [Basic Access (Base64 encoded)](/docs/api/getting-started#basic-access-base64-encoded).
26+
1. Click **Save**. After save, the **Templates** dropdown shows a list of all incident templates by name configured in your Cloud SOAR environment.
27+
1. Select a **Template**.
28+
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:
29+
30+
```
31+
{
32+
"template_id": <Template ID>,
33+
"fields": {
34+
"incidentid": "Incident Id"
35+
}
36+
}
37+
```
2838
29-
For more detailed instructions, see [Configure a webhook for Cloud SOAR](/docs/cloud-soar/automation/#configure-a-webhook-for-cloud-soar).
39+
You can add additional variables. For example:
40+
41+
```
42+
{
43+
"fields": {
44+
"description": "string",
45+
"additional_info": "string",
46+
"starttime": "ISO-8601 datetime string",
47+
"incident_kind": <ID incident kind>,
48+
"incident_category": <ID incident category>,
49+
"status": <ID incident status>,
50+
"restriction": <ID incident restriction>
51+
}
52+
}
53+
```
54+
:::note
55+
* For details on variables you can use as parameters within your JSON object, see [Configure Webhook Payload Variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).
56+
* For information on additional fields, please refer to the [Cloud SOAR APIs](/docs/api/cloud-soar/) documentation.
57+
* The preceding example shows an `ISO-8601 datetime string`. For information about how to configure it, see [parser documentation](https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse).
58+
:::
59+
1. Click **Save**.

0 commit comments

Comments
 (0)