The client ID to use when connecting to the MQTT broker. If blank, a random client ID is used.
Username
The username to use when connecting to the MQTT broker.
Password
The password to use when connecting to the MQTT broker.
QoS
The quality of service to use when sending the message. Options are At most once, At least once, and Exactly once.
Retain
If set to true, the message will be retained by the broker.
TLS
TLS configuration options, including CA certificate, client certificate, and client key, and disable certificate verification.
Disable resolved message
Enable this option to prevent notifications when an alert resolves.
Default JSON payload
If the Message format option is json (the default), the payload is like this example.
json
{"receiver":"My MQTT integration","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":"{}:{}","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"}
Body
If the Message format option is json (the default), the payload contains the following fields.
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
message
string
Custom message configured in Message (Optional Settings). Supports
notification templates; the output is formatted as a string.
Note
When using the jsonMessage format, only the message field of the JSON payload is customizable, and its output is formatted as a string.
To customize the full payload in text or JSON format, use the text format and define a
custom payload.
Alert object
The Alert object represents an alert included in the notification group, as provided by the
alerts field.
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
A link to the Grafana Dashboard if the alert has a Dashboard UID annotation.
panelURL
string
A link to the panel if the alert has a Panel ID annotation.
imageURL
string
URL of a screenshot of a panel assigned to the rule that created this notification.
Custom payload
When you set the Message format option to text, you can customize the entire payload of the MQTT message.
In this mode, the Message option defines the entire payload. It supports
notification templates and can generate notification messages in plain text, JSON, or any custom format.
