oncall-engine/docs/sources/configure/integrations/_index.md
Jack Baldry 9ae442faa6
Replace docs/reference shortcode with ref URIs (#4301)
You can use `ref` URIs in admonitions (or any shortcodes) because they
are inline and not subject to the issues noted in the [`admonition`
shortcode](https://grafana.com/docs/writers-toolkit/write/shortcodes/#code-shortcode:~:text=to%20core%20understanding.-,WARNING,For%20more%20information%2C%20refer%20to%20Markdown%20Reference%20Links%20in%20Shortcodes.,-Examples).

The `ref` URIs perform the same pattern matching as `docs/reference` but
don't require the use of reference-style links and the destinations are
ordinary (full) URLs that can include version substitution. Unlike
`docs/reference`, the implementation doesn't use `relref` so you don't
have to be careful with omitting trailing slashes and the links will
follow redirects.

Documentation:
https://grafana.com/docs/writers-toolkit/write/links/#link-from-source-content-thats-used-in-multiple-projects

To check the links, refer to the deploy preview in
https://github.com/grafana/website/pull/19630.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2024-07-29 14:13:24 +00:00

4.8 KiB
Raw Permalink Blame History

title menuTitle description weight keywords canonical aliases refs
Grafana OnCall integrations Integrations An introduction to Grafana OnCall integrations. 100
OnCall
Integrations
Alerts
Webhook integration
Notifications
https://grafana.com/docs/oncall/latest/configure/integrations/
/docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/
/docs/grafana-cloud/alerting-and-irm/oncall/integrations/
../integrations/
integration-references group-id-templates intergration-references appearance-templates inbound-email alert-workflow integration-labels routing-template behavioral-templates webhooks jinja2-templating
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/references/
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#grouping-id-template
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#grouping-id-template
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#appearance-templates
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#appearance-templates
pattern destination
/docs/oncall /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email/
pattern destination
/docs/grafana-cloud /docs/oncall/<ONCALL_VERSION>/configure/integrations/references/inbound-email/
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/set-up/get-started/#learn-about-the-alert-workflow
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/set-up/get-started/#learn-about-the-alert-workflow
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/integrations/labels/
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/labels/
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#routing-template
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#routing-template
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/#behavioral-templates
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/#behavioral-templates
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/integrations/outgoing-webhooks/
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/integrations/outgoing-webhooks/
pattern destination
/docs/oncall/ /docs/oncall/<ONCALL_VERSION>/configure/jinja2-templating/
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/alerting-and-irm/oncall/configure/jinja2-templating/

Grafana OnCall integrations

An integration serves as the primary entry point for alerts that are processed by Grafana OnCall. Integrations receive alerts through a unique API URL, interpret them using a set of templates tailored for the specific monitoring system, and initiate escalations as necessary.

For more information about how to configure an integration, refer to Configure and manage integrations.

Understand the integration alert flow

  • An alert is received on an integrations Unique URL as an HTTP POST request with a JSON payload (or via Inbound email for email integrations).

  • The incoming alert is routed according to the Routing Template.

  • Alerts are grouped based on the Grouping ID Template and rendered using Appearance Templates.

  • The alert group can be published to messaging platforms, based on the Publish to Chatops configuration.

  • The alert group is escalated to users according to the Escalation Chains selected for the route.

  • An alert group can be acknowledged or resolved with status updates based on its Behavioral Templates.

  • Users can perform actions listed in the Alert Workflow section.

Explore available integrations

Refer to Integration references for a list of available integrations and specific set up instructions.