alerting/webhook doc update (#87492)

* alerting/webhook doc update

* text formath

* fixed admonition

* typo

* headings

* formatted headings and prettified it all

* one more heading
pull/87407/head^2
antonio 1 year ago committed by GitHub
parent 8ca4d73c40
commit d83cbe4d85
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 2
      docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-slack.md
  2. 2
      docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-telegram.md
  3. 43
      docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md

@ -16,7 +16,7 @@ title: Configure Slack for Alerting
weight: 300
---
## Configure Slack for Alerting
# Configure Slack for Alerting
Use the Grafana Alerting - Slack integration to send Slack notifications when your alerts are firing.

@ -16,7 +16,7 @@ title: Configure Telegram for Alerting
weight: 300
---
## Configure Telegram for Alerting
# Configure Telegram for Alerting
Use the Grafana Alerting - Telegram integration to send [Telegram](https://telegram.org/) notifications when your alerts are firing.

@ -24,9 +24,11 @@ title: Configure the webhook notifier for Alerting
weight: 200
---
### Configure the webhook notifier for Alerting
# Configure the webhook notifier for Alerting
Example JSON body:
The webhook notification is a simple way to send information about a state change over HTTP to a custom endpoint. Using this notification you could integrate Grafana into a system of your choosing.
## Webhook JSON payload
```json
{
@ -98,9 +100,9 @@ Example JSON body:
}
```
### Webhook fields
## Webhook fields
## Body
### Body
| Key | Type | Description |
| ----------------- | ------------------------- | ------------------------------------------------------------------------------- |
@ -136,18 +138,31 @@ Example JSON body:
| panelURL | string | **Will be deprecated soon** |
| imageURL | string | URL of a screenshot of a panel assigned to the rule that created this notification |
### Removed fields related to dashboards
{{< admonition type="note" >}}
Alert rules are not coupled to dashboards anymore therefore the fields related to dashboards `dashboardId` and `panelId` have been removed.
{{< /admonition >}}
## Procedure
To create your webhook integration in Grafana Alerting, complete the following steps:
Alerts are not coupled to dashboards anymore therefore the fields related to dashboards `dashboardId` and `panelId` have been removed.
1. Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**.
1. Click **+ Add contact point**.
1. Enter a contact point name.
1. From the Integration list, select **Webhook**.
1. In the **URL** field, copy in your Webhook URL.
1. Click **Test** to check that your integration works.
1. Click **Save contact point**.
## WeCom
## Next steps
WeCom contact points need a Webhook URL. These are obtained by setting up a WeCom robot on the corresponding group chat. To obtain a Webhook URL using the WeCom desktop Client please follow these steps:
To add the contact point and integration you created to your default notification policy, complete the following steps.
1. Click the "..." in the top right corner of a group chat that you want your alerts to be delivered to
2. Click "Add Group Robot", select "New Robot" and give your robot a name. Click "Add Robot"
3. There should be a Webhook URL in the panel.
1. Navigate to **Alerts & IRM** -> **Alerting** -> **Notification policies**.
1. In the **Default policy**, click the ellipsis icon (…) and then **Edit**.
1. Change the default policy to the contact point you created.
1. Click **Update default policy**.
| Setting | Description |
| ------- | ------------------ |
| Url | WeCom webhook URL. |
{{< admonition type="note" >}}
If you have more than one contact point, add a new notification policy rather than edit the default one, so you can route specific alerts to your webhook.
{{< /admonition >}}

Loading…
Cancel
Save