grafana/docs/sources/alerting/configure-notifications/template-notifications/_index.md

68 lines
3.2 KiB
Markdown
Raw Normal View History

---
Revert "Revert "Alerting docs: rework create alert rules definition and topic"" (#83372) * Revert "Revert "Alerting docs: rework create alert rules definition and topic…" This reverts commit 2b4f1087712e82d17db8ce29adf4a40f5b76e0fc. * updates aliases * fixes after testing aliases * more alias updates * test silence alias * fix alias for mute timings * attempt alias fix * ran prettier * fixes more aliases * quick title update * fixes alias * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/reference.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-silence.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/mute-timings.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/manage-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-notification-policy.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/mute-timings.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * fix silence aliases * fix canonical * Update docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-notification-policy.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> --------- Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 18:56:11 +08:00
aliases:
Alerting docs: restructure `Introduction` (#84248) * 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>
2024-03-14 23:58:18 +08:00
- ../manage-notifications/template-notifications/ # /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/template-notifications/
Revert "Revert "Alerting docs: rework create alert rules definition and topic"" (#83372) * Revert "Revert "Alerting docs: rework create alert rules definition and topic…" This reverts commit 2b4f1087712e82d17db8ce29adf4a40f5b76e0fc. * updates aliases * fixes after testing aliases * more alias updates * test silence alias * fix alias for mute timings * attempt alias fix * ran prettier * fixes more aliases * quick title update * fixes alias * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/reference.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/use-notification-templates.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/using-go-templating-language.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-silence.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/mute-timings.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/manage-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-notification-policy.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/configure-oncall.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/manage-contact-points/integrations/webhook-notifier.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/mute-timings.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/template-notifications/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * fix silence aliases * fix canonical * Update docs/sources/alerting/configure-notifications/template-notifications/create-notification-templates.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/alerting/configure-notifications/create-notification-policy.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> --------- Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 18:56:11 +08:00
canonical: https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/
description: Customize your notifications using notification templates
keywords:
- grafana
- alerting
- notifications
- templates
Explicitly set all front matter labels in the source files (#71548) * Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
labels:
products:
- cloud
- enterprise
- oss
title: Configure notification messages
weight: 430
refs:
use-notification-templates:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/template-notifications/use-notification-templates/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/use-notification-templates/
reference:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/template-notifications/reference/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/reference/
using-go-templating-language:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/configure-notifications/template-notifications/using-go-templating-language/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/alerting-and-irm/alerting/configure-notifications/template-notifications/using-go-templating-language/
---
# Configure notification messages
Customize the content of your notifications with notifications templates.
You can use notification templates to change the title, message, and format of the message in your notifications.
Notification templates are not tied to specific contact point integrations, such as email or Slack. However, you can choose to create separate notification templates for different contact point integrations.
You can use notification templates to:
- Customize content: Personalize the subject of an email or the title of a message. Modify text within notifications, like selecting or omitting certain labels, annotations, and links. Format text with bold and italic styles, and add or remove line breaks.
However, there are limitations. You cannot:
- Modify Visual Appearance: Add HTML and CSS to email notifications for visual changes. Alter the design of notifications in messaging services like Slack and Microsoft Teams, such as adding custom blocks or adaptive cards.
- Manage Media and Data: Adjust the number and size of images or their placement in notifications. Customize webhook data structure or format, including JSON fields or sending data in XML. Modify HTTP headers in webhooks beyond those in the contact point configuration.
## Learn more
[Using Go's templating language](ref:using-go-templating-language)
Learn how to write the content of your notification templates in Gos templating language.
Create reusable notification templates for your contact points.
[Use notification templates](ref:use-notification-templates)
Use notification templates to send notifications to your contact points.
[Reference](ref:reference)
Data that is available when writing templates.