mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 07:12:20 +08:00
ec42b2a361
* Rename `Data sources` title * Relocate and rename `Introduction/Notification templates` * Rename `alert-rules/alert-instances` to `alert-rules/multi-dimensional-alerts` * Move `fundamentals/high-availability` to `setup/enable-ha` * Fix 404 high-availability alerting link on Setup HA Grafana docs * Move alert manager/contact poitns/notification templates within Notifications * Remove `Alerting on numeric data` * Restructure Introduction v2 * Continue Intro restructuring * Update docs/sources/alerting/fundamentals/alert-rules/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Complete contact point TODO * Alias: alertManager * Aliases `annotation-label` + content changes * Aliases to `templating-labels-annotations` * Aliases to `queries-conditions` * Rename `rule-evaluation.md` file * Aliases: `contact points` * Aliases to `message-templating` * Aliases to `alert-rules` * Update links to new URL slugs * Remove duplicated alias * Remove trailing slash for external heading links * Remove trailing slash in heading links to other grafana pages * Change URL directory slug `fundamentals/notifications` * rename title `Configure High Availability` * Content changes * Update docs/sources/alerting/fundamentals/alert-rules/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-alert-state-history/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-high-availability/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-alert-state-history/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-high-availability/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-high-availability/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/configure-high-availability/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/fundamentals/alert-rules/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Fix broken link reference * Fix `queries-and-conditions` * Fix `alert-rule-evaluation` ref link * Fix aliases + inline doc comments * Fix broken link --------- Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
154 lines
8.3 KiB
Markdown
154 lines
8.3 KiB
Markdown
---
|
|
aliases:
|
|
- ../../../fundamentals/contact-points/notifiers/webhook-notifier/ # /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/contact-points/notifiers/webhook-notifier/
|
|
- ../../../fundamentals/contact-points/webhook-notifier/ # /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/contact-points/webhook-notifier/
|
|
- ../../../manage-notifications/manage-contact-points/webhook-notifier/ # /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/manage-contact-points/webhook-notifier/
|
|
- alerting/manage-notifications/manage-contact-points/webhook-notifier/
|
|
- ../../../alerting-rules/manage-contact-points/integrations/webhook-notifier/ # /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/manage-contact-points/integrations/webhook-notifier/
|
|
|
|
canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier/
|
|
description: Configure the webhook notifier integration for Alerting
|
|
keywords:
|
|
- grafana
|
|
- alerting
|
|
- guide
|
|
- contact point
|
|
- templating
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
- oss
|
|
menuTitle: Webhook notifier
|
|
title: Configure the webhook notifier for Alerting
|
|
weight: 200
|
|
---
|
|
|
|
### Configure the webhook notifier for Alerting
|
|
|
|
Example JSON body:
|
|
|
|
```json
|
|
{
|
|
"receiver": "My Super Webhook",
|
|
"status": "firing",
|
|
"orgId": 1,
|
|
"alerts": [
|
|
{
|
|
"status": "firing",
|
|
"labels": {
|
|
"alertname": "High memory usage",
|
|
"team": "blue",
|
|
"zone": "us-1"
|
|
},
|
|
"annotations": {
|
|
"description": "The system has high memory usage",
|
|
"runbook_url": "https://myrunbook.com/runbook/1234",
|
|
"summary": "This alert was triggered for zone us-1"
|
|
},
|
|
"startsAt": "2021-10-12T09:51:03.157076+02:00",
|
|
"endsAt": "0001-01-01T00:00:00Z",
|
|
"generatorURL": "https://play.grafana.org/alerting/1afz29v7z/edit",
|
|
"fingerprint": "c6eadffa33fcdf37",
|
|
"silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1",
|
|
"dashboardURL": "",
|
|
"panelURL": "",
|
|
"values": {
|
|
"B": 44.23943737541908,
|
|
"C": 1
|
|
}
|
|
},
|
|
{
|
|
"status": "firing",
|
|
"labels": {
|
|
"alertname": "High CPU usage",
|
|
"team": "blue",
|
|
"zone": "eu-1"
|
|
},
|
|
"annotations": {
|
|
"description": "The system has high CPU usage",
|
|
"runbook_url": "https://myrunbook.com/runbook/1234",
|
|
"summary": "This alert was triggered for zone eu-1"
|
|
},
|
|
"startsAt": "2021-10-12T09:56:03.157076+02:00",
|
|
"endsAt": "0001-01-01T00:00:00Z",
|
|
"generatorURL": "https://play.grafana.org/alerting/d1rdpdv7k/edit",
|
|
"fingerprint": "bc97ff14869b13e3",
|
|
"silenceURL": "https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1",
|
|
"dashboardURL": "",
|
|
"panelURL": "",
|
|
"values": {
|
|
"B": 44.23943737541908,
|
|
"C": 1
|
|
}
|
|
}
|
|
],
|
|
"groupLabels": {},
|
|
"commonLabels": {
|
|
"team": "blue"
|
|
},
|
|
"commonAnnotations": {},
|
|
"externalURL": "https://play.grafana.org/",
|
|
"version": "1",
|
|
"groupKey": "{}:{}",
|
|
"truncatedAlerts": 0,
|
|
"title": "[FIRING:2] (blue)",
|
|
"state": "alerting",
|
|
"message": "**Firing**\n\nLabels:\n - alertname = T2\n - team = blue\n - zone = us-1\nAnnotations:\n - description = This is the alert rule checking the second system\n - runbook_url = https://myrunbook.com\n - summary = This is my summary\nSource: https://play.grafana.org/alerting/1afz29v7z/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1\n\nLabels:\n - alertname = T1\n - team = blue\n - zone = eu-1\nAnnotations:\nSource: https://play.grafana.org/alerting/d1rdpdv7k/edit\nSilence: https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1\n"
|
|
}
|
|
```
|
|
|
|
### Webhook fields
|
|
|
|
## Body
|
|
|
|
| Key | Type | Description |
|
|
| ----------------- | ------------------------- | ------------------------------------------------------------------------------- |
|
|
| receiver | string | Name of the webhook |
|
|
| status | string | Current status of the alert, `firing` or `resolved` |
|
|
| orgId | number | ID of the organization related to the payload |
|
|
| alerts | array of [alerts](#alert) | Alerts that are triggering |
|
|
| groupLabels | object | Labels that are used for grouping, map of string keys to string values |
|
|
| commonLabels | object | Labels that all alarms have in common, map of string keys to string values |
|
|
| commonAnnotations | object | Annotations that all alarms have in common, map of string keys to string values |
|
|
| externalURL | string | External URL to the Grafana instance sending this webhook |
|
|
| version | string | Version of the payload |
|
|
| groupKey | string | Key that is used for grouping |
|
|
| truncatedAlerts | number | Number of alerts that were truncated |
|
|
| title | string | **Will be deprecated soon** |
|
|
| state | string | **Will be deprecated soon** |
|
|
| message | string | **Will be deprecated soon** |
|
|
|
|
### Alert
|
|
|
|
| Key | Type | Description |
|
|
| ------------ | ------ | ---------------------------------------------------------------------------------- |
|
|
| status | string | Current status of the alert, `firing` or `resolved` |
|
|
| labels | object | Labels that are part of this alert, map of string keys to string values |
|
|
| annotations | object | Annotations that are part of this alert, map of string keys to string values |
|
|
| startsAt | string | Start time of the alert |
|
|
| endsAt | string | End time of the alert, default value when not resolved is `0001-01-01T00:00:00Z` |
|
|
| values | object | Values that triggered the current status |
|
|
| generatorURL | string | URL of the alert rule in the Grafana UI |
|
|
| fingerprint | string | The labels fingerprint, alarms with the same labels will have the same fingerprint |
|
|
| silenceURL | string | URL to silence the alert rule in the Grafana UI |
|
|
| dashboardURL | string | **Will be deprecated soon** |
|
|
| 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
|
|
|
|
Alerts are not coupled to dashboards anymore therefore the fields related to dashboards `dashboardId` and `panelId` have been removed.
|
|
|
|
## WeCom
|
|
|
|
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:
|
|
|
|
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.
|
|
|
|
| Setting | Description |
|
|
| ------- | ------------------ |
|
|
| Url | WeCom webhook URL. |
|