2022-06-09 10:08:07 +01:00
|
|
|
|
---
|
|
|
|
|
|
aliases:
|
2022-10-25 10:41:01 -04:00
|
|
|
|
- ../add-webhook-integration/
|
2023-10-05 11:41:31 +03:00
|
|
|
|
canonical: https://grafana.com/docs/oncall/latest/integrations/webhook/
|
2022-06-09 10:08:07 +01:00
|
|
|
|
keywords:
|
2022-10-25 10:41:01 -04:00
|
|
|
|
- Grafana Cloud
|
|
|
|
|
|
- Alerts
|
|
|
|
|
|
- Notifications
|
|
|
|
|
|
- on-call
|
|
|
|
|
|
- Alertmanager
|
|
|
|
|
|
- Prometheus
|
2023-05-24 14:11:21 +03:00
|
|
|
|
title: Inbound Webhook
|
2022-06-09 10:08:07 +01:00
|
|
|
|
weight: 700
|
|
|
|
|
|
---
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2023-05-24 14:11:21 +03:00
|
|
|
|
# Inbound Webhook integrations for Grafana OnCall
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2022-12-01 14:26:54 +01:00
|
|
|
|
Grafana OnCall directly supports many integrations, those that aren’t currently listed in the Integrations menu can be
|
|
|
|
|
|
connected using the webhook integration and configured alert templates.
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2022-06-09 10:08:07 +01:00
|
|
|
|
With the webhook integration, you can connect to any alert source that isn't listed in the **Create Integration** page.
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2022-06-08 14:10:12 -06:00
|
|
|
|
There are two available formats, **Webhook** and **Formatted Webhook**.
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2022-06-09 10:08:07 +01:00
|
|
|
|
- **Webhook** will pull all of the raw JSON payload and display it in the manner that it's received.
|
2022-12-01 14:26:54 +01:00
|
|
|
|
- **Formatted Webhook** can be used if the alert payload sent by your monitoring service is formatted in a way that
|
|
|
|
|
|
OnCall recognizes.
|
2022-06-09 10:08:07 +01:00
|
|
|
|
|
|
|
|
|
|
The following fields are recognized, but none are required:
|
|
|
|
|
|
|
|
|
|
|
|
- `alert_uid`: a unique alert ID for grouping.
|
|
|
|
|
|
- `title`: a title.
|
|
|
|
|
|
- `image_url`: a URL for an image attached to alert.
|
|
|
|
|
|
- `state`: either `ok` or `alerting`. Helpful for auto-resolving.
|
|
|
|
|
|
- `link_to_upstream_details`: link back to your monitoring system.
|
|
|
|
|
|
- `message`: alert details.
|
2022-06-08 14:10:12 -06:00
|
|
|
|
|
|
|
|
|
|
To configure a webhook integration:
|
|
|
|
|
|
|
2023-03-08 16:42:18 +08:00
|
|
|
|
1. In the **Integrations** tab, click **+ New integration to receive alerts**.
|
2022-06-09 10:08:07 +01:00
|
|
|
|
2. Select either **Webhook** or **Formatted Webhook** integration.
|
2022-06-08 14:10:12 -06:00
|
|
|
|
3. Follow the configuration steps in the **How to connect** section of the integration settings.
|
2022-12-01 14:26:54 +01:00
|
|
|
|
4. Use the unique webhook URL to complete any configuration in your monitoring service to send POST requests. Use any
|
|
|
|
|
|
http client, e.g. curl to send POST requests with any payload.
|
2022-06-09 10:08:07 +01:00
|
|
|
|
|
|
|
|
|
|
For example:
|
2022-06-03 08:09:47 -06:00
|
|
|
|
|
2023-05-24 14:11:21 +03:00
|
|
|
|
```bash
|
|
|
|
|
|
curl -X POST \
|
|
|
|
|
|
https://a-prod-us-central-0.grafana.net/integrations/v1/formatted_webhook/m12xmIjOcgwH74UF8CN4dk0Dh/ \
|
|
|
|
|
|
-H 'Content-Type: Application/json' \
|
|
|
|
|
|
-d '{
|
|
|
|
|
|
"alert_uid": "08d6891a-835c-e661-39fa-96b6a9e26552",
|
|
|
|
|
|
"title": "The whole system is down",
|
|
|
|
|
|
"image_url": "https://upload.wikimedia.org/wikipedia/commons/e/ee/Grumpy_Cat_by_Gage_Skidmore.jpg",
|
|
|
|
|
|
"state": "alerting",
|
|
|
|
|
|
"link_to_upstream_details": "https://en.wikipedia.org/wiki/Downtime",
|
|
|
|
|
|
"message": "Smth happened. Oh no!"
|
|
|
|
|
|
}'
|
|
|
|
|
|
```
|
2022-06-08 14:10:12 -06:00
|
|
|
|
|
2022-12-01 14:26:54 +01:00
|
|
|
|
To learn how to use custom alert templates for formatted webhooks, see
|
2023-07-13 15:38:35 +01:00
|
|
|
|
[Configure alerts templates][jinja2-templating].
|
|
|
|
|
|
|
|
|
|
|
|
{{% docs/reference %}}
|
|
|
|
|
|
[jinja2-templating]: "/docs/oncall/ -> /docs/oncall/<ONCALL VERSION>/jinja2-templating"
|
|
|
|
|
|
[jinja2-templating]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/jinja2-templating"
|
|
|
|
|
|
{{% /docs/reference %}}
|