oncall-engine/docs/sources/integrations/webhook/index.md
Jack Baldry d3921a5386
Remove absolute aliases as it can cause unexpected redirects in future versions (#1793)
If a page is removed in a future version, the presence of a "latest"
absolute alias in a previous version can redirect that removed page.

**Notes for reviewer:**
I would like to make similar changes for older, previously published
versions.
I believe you are only publishing documentation on specific tag events
and are not maintaining long lived release branches for backporting
fixes into.
If my understanding is correct, I will make the changes in the website
repository
(https://github.com/grafana/website/tree/master/content/docs/oncall).

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-06-05 09:03:38 +00:00

2.4 KiB
Raw Blame History

aliases canonical keywords title weight
../add-webhook-integration/
https://grafana.com/docs/oncall/latest/integrations/available-integrations/configure-webhook/
Grafana Cloud
Alerts
Notifications
on-call
Alertmanager
Prometheus
Inbound Webhook 700

Inbound Webhook integrations for Grafana OnCall

Grafana OnCall directly supports many integrations, those that arent currently listed in the Integrations menu can be connected using the webhook integration and configured alert templates.

With the webhook integration, you can connect to any alert source that isn't listed in the Create Integration page.

There are two available formats, Webhook and Formatted Webhook.

  • Webhook will pull all of the raw JSON payload and display it in the manner that it's received.

  • Formatted Webhook can be used if the alert payload sent by your monitoring service is formatted in a way that OnCall recognizes.

    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.

To configure a webhook integration:

  1. In the Integrations tab, click + New integration to receive alerts.
  2. Select either Webhook or Formatted Webhook integration.
  3. Follow the configuration steps in the How to connect section of the integration settings.
  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.

For example:

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!"
}'

To learn how to use custom alert templates for formatted webhooks, see [Configure alerts templates]({{< relref "jinja2-templating" >}}).