Update Webhook connections documentations #6145

amee-sumo · 2025-12-25T12:22:10Z

… page

Purpose of this pull request

This pull request is to update the creation of Webhook connection according to new connection UI

Select the type of change

Minor Changes - Typos, formatting, slight revisions
Update Content - Revisions, updating sections
New Content - New features, sections, pages, tutorials
Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1289

… page

docs/alerts/webhook-connections/aws-lambda.md

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

docs/alerts/webhook-connections/datadog.md

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

jpipkin1 · 2025-12-26T20:03:34Z

docs/alerts/webhook-connections/jira-server.md

+   * **Name**. Enter a name for the Connection.
+   * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:03:54Z

docs/alerts/webhook-connections/jira-server.md

+      :::
+   * **Authorization Header**. Enter your **Authorization Header** from the [prerequisites](#prerequisites). For example, `Basic <random string>`.
+   * (Optional) **Custom Headers**, enter up to five comma separated key-value pairs.
+   * The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid Project Key.


Suggested change

* The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid Project Key.

* The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid project key.

jpipkin1 · 2025-12-26T20:08:02Z

docs/alerts/webhook-connections/jira-service-desk.md

+      :::
+   * **Authorization Header**. Enter your **Authorization Header** from the [prerequisites](#prerequisites). For example, `Basic <random string>`.
+   * (Optional) **Custom Headers**, enter up to five comma separated key-value pairs.
+   * The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid Project Key.


Suggested change

* The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid Project Key.

* The following input fields are automatically updated in the JSON **Payload** and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid project key.

jpipkin1 · 2025-12-26T20:09:31Z

docs/alerts/webhook-connections/jira-service-desk.md

+      * **Issue Summary**
+      * (optional) **Priority**
+      * **Issue Description**
+1. The following JSON is an example of the default **Alert Payload**, which you can customize. For details on the variables you can use as parameters within your JSON object, see [Webhook Payload Variables](/docs/alerts/webhook-connections/set-up-webhook-connections).


Suggested change

1. The following JSON is an example of the default **Alert Payload**, which you can customize. For details on the variables you can use as parameters within your JSON object, see [Webhook Payload Variables](/docs/alerts/webhook-connections/set-up-webhook-connections).

1. The following JSON is an example of the default **Alert Payload**, which you can customize. For details on the 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).

jpipkin1 · 2025-12-26T20:12:46Z

docs/alerts/webhook-connections/microsoft-azure-functions.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:13:15Z

docs/alerts/webhook-connections/microsoft-azure-functions.md

+    * **URL**. Enter the function URL for the endpoint from the previous section.
+    * (Optional) **Authorization Header**. Enter an authorization header, which may include an authorization token.
+    * (Optional) **Custom Headers**. Enter up to five comma separated key-value pairs.
+1. Under **Alert Payload**, enter a JSON object in the format required. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).


Suggested change

1. Under **Alert Payload**, enter a JSON object in the format required. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).

1. Under **Alert Payload**, enter a JSON object in the format required. For details on variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

jpipkin1 · 2025-12-26T20:14:53Z

docs/alerts/webhook-connections/microsoft-teams.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:16:10Z

docs/alerts/webhook-connections/new-relic.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:17:39Z

docs/alerts/webhook-connections/new-relic.md

+    * **URL**. Enter the **URL** for the endpoint. See [Create an API Key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).
+        ```
+        https://insights-collector.newrelic.com/v1/accounts/ACCOUNT_ID/events
+        ```
+    * **Insert Key**. Enter your API Key generated from New Relic Insights. See [Create an API Key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).


Suggested change

* **URL**. Enter the **URL** for the endpoint. See [Create an API Key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).

```

https://insights-collector.newrelic.com/v1/accounts/ACCOUNT_ID/events

```

* **Insert Key**. Enter your API Key generated from New Relic Insights. See [Create an API Key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).

* **URL**. Enter the **URL** for the endpoint. See [Create an API key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).

```

https://insights-collector.newrelic.com/v1/accounts/ACCOUNT_ID/events

```

* **Insert Key**. Enter your API Key generated from New Relic Insights. See [Create an API key for New Relic Webhook](#create-an-api-keyfor-new-relic-webhook).

jpipkin1 · 2025-12-26T20:19:42Z

docs/alerts/webhook-connections/opsgenie-legacy.md

+    * **Name**. Enter **Sumo Logic Opsgenie** as the name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter **Sumo Logic Opsgenie** as the name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter **Sumo Logic Opsgenie** as the name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:20:04Z

docs/alerts/webhook-connections/opsgenie-legacy.md

+    * (Optional) **Custom Headers**. Enter up to five comma separated key-value pairs.
 1. Enter the following content in the **Alert Payload** field:
    :::note
    Opsgenie uses the priority value in the Payload field to define the priority of alerts. For this reason, you should change the priority to match your needs.


Suggested change

Opsgenie uses the priority value in the Payload field to define the priority of alerts. For this reason, you should change the priority to match your needs.

Opsgenie uses the priority value in the payload field to define the priority of alerts. For this reason, you should change the priority to match your needs.

jpipkin1 · 2025-12-26T20:20:55Z

docs/alerts/webhook-connections/opsgenie.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:22:30Z

docs/alerts/webhook-connections/opsgenie.md

+    * (Optional) **Authorization Header**. Enter an authorization header, which may include an authorization token.
+    * (Optional) **Custom Headers**. Enter up to five comma separated key-value pairs.
+    * (Optional) **Priority**. Opsgenie uses the **Priority** value to define the priority of alerts. Edits to the **Priority** value are automatically updated in the JSON payload and vice versa.
 1. The following JSON is the default **Alert Payload**, you can customize it as needed. For details on variables you can use as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).


Suggested change

1. The following JSON is the default **Alert Payload**, you can customize it as needed. For details on variables you can use as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).

1. The following JSON is the default **Alert Payload**, you can customize it as needed. 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).

jpipkin1 · 2025-12-26T20:23:44Z

docs/alerts/webhook-connections/pagerduty.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:26:00Z

docs/alerts/webhook-connections/pagerduty.md

     :::
-1. For details on other variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
-1. Click **Save**.<br/><img src={useBaseUrl('img/connection-and-integration/v2.png')} alt="PagerDuty default payload v2" style={{border: '1px solid gray'}} width="700" />
+    * For details on other variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).


Suggested change

* For details on other variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).

* For details on other variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

jpipkin1 · 2025-12-26T20:26:24Z

docs/alerts/webhook-connections/pagerduty.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:28:44Z

docs/alerts/webhook-connections/servicenow/set-up-connections.md

+   * **Name**. Enter a name for the Connection.
+   * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:30:26Z

docs/alerts/webhook-connections/servicenow/set-up-connections.md

+   * **Name**. Enter a name for the Connection.
+   * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:31:19Z

docs/alerts/webhook-connections/set-up-webhook-connections.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:32:47Z

docs/alerts/webhook-connections/signl4.md

+    * **Name**. Enter **Sumo Logic SIGNL4** as the name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.


Suggested change

* **Name**. Enter **Sumo Logic SIGNL4** as the name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **Name**. Enter **Sumo Logic SIGNL4** as the name for the connection.

* (Optional) **Description**. Enter a description for the connection.

jpipkin1 · 2025-12-26T20:34:29Z

docs/alerts/webhook-connections/slack.md

+    * **Name**. Enter a name for the Connection.
+    * (Optional) **Description**. Enter a Description for the Connection.
+    * **URL**. Enter the URL for the endpoint. See [Slack API Help](https://api.slack.com/incoming-webhooks) for more information.


Suggested change

* **Name**. Enter a name for the Connection.

* (Optional) **Description**. Enter a Description for the Connection.

* **URL**. Enter the URL for the endpoint. See [Slack API Help](https://api.slack.com/incoming-webhooks) for more information.

* **Name**. Enter a name for the connection.

* (Optional) **Description**. Enter a description for the connection.

* **URL**. Enter the URL for the endpoint. See [Slack API help](https://api.slack.com/incoming-webhooks) for more information.

jpipkin1 · 2025-12-26T20:35:38Z

docs/alerts/webhook-connections/slack.md

+    * (Optional) **Description**. Enter a Description for the Connection.
+    * **URL**. Enter the URL for the endpoint. See [Slack API Help](https://api.slack.com/incoming-webhooks) for more information.
+    * (Optional) **Custom Headers**. Enter up to five comma separated key-value pairs.
 1. Under **Alert Payload**, which allows you to customize how the alert notification look in Slack, enter a JSON object in the format required by Slack. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md). 


Suggested change

1. Under **Alert Payload**, which allows you to customize how the alert notification look in Slack, enter a JSON object in the format required by Slack. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).

1. Under **Alert Payload**, which allows you to customize how the alert notification look in Slack, enter a JSON object in the format required by Slack. For details on variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

jpipkin1

Approved, @amee-sumo. I have only minor suggestions.

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

Update Webhook connections documentations according to new connection…

ce1ac75

… page

amee-sumo self-assigned this Dec 25, 2025

amee-sumo requested review from jpipkin1 and kimsauce as code owners December 25, 2025 12:22

amee-sumo added the doc:update Revisions and updates to content label Dec 25, 2025

amee-sumo requested review from JV0812 and mafsumo as code owners December 25, 2025 12:22

amee-sumo added the do-not-merge Pull requests that should not be merged label Dec 25, 2025

cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Dec 25, 2025

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

docs/alerts/webhook-connections/aws-lambda.md Outdated Show resolved Hide resolved

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

docs/alerts/webhook-connections/cloud-soar.md Outdated Show resolved Hide resolved

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

docs/alerts/webhook-connections/datadog.md Outdated Show resolved Hide resolved

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

docs/alerts/webhook-connections/jira-cloud.md Outdated Show resolved Hide resolved

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

docs/alerts/webhook-connections/jira-cloud.md Outdated Show resolved Hide resolved

jpipkin1 reviewed Dec 26, 2025

View reviewed changes

jpipkin1 approved these changes Dec 26, 2025

View reviewed changes

amee-sumo and others added 5 commits December 30, 2025 21:46

Update docs/alerts/webhook-connections/aws-lambda.md

d1fdb28

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

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

797135c

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

Update docs/alerts/webhook-connections/datadog.md

de4fc2d

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

Update docs/alerts/webhook-connections/jira-cloud.md

6156480

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

Update docs/alerts/webhook-connections/jira-cloud.md

5ac21d6

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

		* Name. Enter a name for the Connection.
		* (Optional) Description. Enter a Description for the Connection.

	* The following input fields are automatically updated in the JSON Payload and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid Project Key.
	* The following input fields are automatically updated in the JSON Payload and vice versa. Update them to meet your requirements. At a minimum, you'll need to enter a valid project key.

	1. The following JSON is an example of the default Alert Payload, which you can customize. For details on the variables you can use as parameters within your JSON object, see [Webhook Payload Variables](/docs/alerts/webhook-connections/set-up-webhook-connections).
	1. The following JSON is an example of the default Alert Payload, which you can customize. For details on the 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).

	1. Under Alert Payload, enter a JSON object in the format required. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
	1. Under Alert Payload, enter a JSON object in the format required. For details on variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

		* Name. Enter Sumo Logic Opsgenie as the name for the Connection.
		* (Optional) Description. Enter a Description for the Connection.

	Opsgenie uses the priority value in the Payload field to define the priority of alerts. For this reason, you should change the priority to match your needs.
	Opsgenie uses the priority value in the payload field to define the priority of alerts. For this reason, you should change the priority to match your needs.

	1. The following JSON is the default Alert Payload, you can customize it as needed. For details on variables you can use as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
	1. The following JSON is the default Alert Payload, you can customize it as needed. 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).

	* For details on other variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
	* For details on other variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

		* Name. Enter Sumo Logic SIGNL4 as the name for the Connection.
		* (Optional) Description. Enter a Description for the Connection.

	1. Under Alert Payload, which allows you to customize how the alert notification look in Slack, enter a JSON object in the format required by Slack. For details on variables that can be used as parameters within your JSON object, see [Webhook Payload Variables](set-up-webhook-connections.md).
	1. Under Alert Payload, which allows you to customize how the alert notification look in Slack, enter a JSON object in the format required by Slack. For details on variables that can be used as parameters within your JSON object, see [Configure Webhook payload variables](/docs/alerts/webhook-connections/set-up-webhook-connections/#configure-webhook-payload-variables).

Update Webhook connections documentations #6145

Are you sure you want to change the base?

Update Webhook connections documentations #6145

Uh oh!

Conversation

amee-sumo commented Dec 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request

Select the type of change

Ticket (if applicable)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpipkin1 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

amee-sumo commented Dec 25, 2025 •

edited

Loading