Skip to content

Commit 50920b4

Browse files
update docs
1 parent 90b3928 commit 50920b4

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

docs/user-guide/management/alert-destinations.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,25 @@ Webhooks are ideal for integrating OpenObserve alerts with third-party platforms
1616
1. In OpenObserve, go to **Management** from the top navigation bar.
1717
2. Select **Alert Destinations**.
1818
3. Select the **Webhook** tab.
19-
4. Fill in the following details:
20-
21-
- **Name**: Enter a descriptive name for the Webhook destination such as **SlackNotifications**.
22-
> Note: Characters like :, ?, /, #, and spaces are not allowed.
23-
- **Template**: Choose a alert message template from the dropdown menu. Refer to [Templates](templates.md) to create or manage templates.
24-
- **URL**: Specify the Webhook endpoint URL where notifications will be sent.
25-
- **Method**: Select the HTTP method depending on the Webhook's requirements.
26-
- **Output Format**: Choose **JSON** unless the receiving system explicitly requires **NDJSON** format.
27-
> Why Output Format Matters <br>
28-
> You define where the alert should be sent — this is the alert destination. <br>
29-
> OpenObserve sends the alert to that destination — which is a remote server. <br>
30-
> The remote server expects the payload in a specific format. <br>
31-
> You choose JSON or NDJSON accordingly. <br>
32-
> **Example:** <br>
33-
> **If the destination is a Slack webhook, choose JSON.** <br>
34-
> **If the destination is another OpenObserve instance, choose JSON.** <br>
35-
> **If the destination is a Splunk HTTP Event Collector (HEC) endpoint, choose NDJSON.** <br>
36-
>
37-
- **Headers (Optional)**: Add custom headers in key-value format such as authentication tokens or content type.
38-
- **Skip TLS Verify**: Enable this option if the endpoint uses self-signed certificates or if you want to bypass SSL verification.
39-
6. Click **Save** to create the Webhook destination.
19+
4. Enter a descriptive name for the Webhook destination such as **SlackNotifications**.
20+
> Note: Characters like :, ?, /, #, and spaces are not allowed.
21+
5. Choose a template from the dropdown menu. Refer to [Templates](templates.md) to create or manage templates.
22+
6. Specify the Webhook endpoint URL where notifications will be sent.
23+
7. Select the HTTP method depending on the Webhook's requirements.
24+
8. Choose **JSON** unless the receiving system explicitly requires **NDJSON** format.
25+
> Why Output Format Matters <br>
26+
> You define where the alert should be sent — this is the alert destination. <br>
27+
> OpenObserve sends the alert to that destination — which is a remote server. <br>
28+
> The remote server expects the payload in a specific format. <br>
29+
> You choose JSON or NDJSON accordingly. <br>
30+
> **Example:** <br>
31+
> **If the destination is a Slack webhook, choose JSON.** <br>
32+
> **If the destination is another OpenObserve instance, choose JSON.** <br>
33+
> **If the destination is a Splunk HTTP Event Collector (HEC) endpoint, choose NDJSON.** <br>
34+
>
35+
9. Under **Headers**, add custom headers in key-value format such as authentication tokens or content type.
36+
10. Enable the **Skip TLS Verify** option if the endpoint uses self-signed certificates or if you want to bypass SSL verification.
37+
9. Click **Save** to create the Webhook destination.
4038

4139
![alert destination](../../images/alert-destination-webhook-slack.png)
4240

@@ -47,9 +45,10 @@ Webhooks are ideal for integrating OpenObserve alerts with third-party platforms
4745
- **URL**: `https://hooks.slack.com/services/T02QBH105PF/B04C7NLLLRE/HY3fXf123`
4846
- **Method**: POST
4947
- **Output Format**: JSON
50-
- **Headers**:
51-
- **Key**: Authorization
52-
- **Value**: Basic cm9vdEBleGFtcGxlLmNvbTpDb21wbGV4GFzcy
48+
- **Headers**:
49+
50+
- **Key**: Authorization
51+
- **Value**: Basic cm9vdEBleGFtcGxlLmNvbTpDb21wbGV4GFzcy
5352

5453

5554
## Configure Email Destinations

0 commit comments

Comments
 (0)