You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Alerting: Add missing fields to contact points integrations (#1060)
* add gitattributes
* add title to discord
* add title to Google chat
* add missing kafka fields: description, details, username, password, api_version, cluster_id
* add constraints to opsGenie's send_tags_as
* pack team's URL as secret
* add missing fields to Telegram: parse_mode, disable_web_page_preview, protect_content, disable_notifications
* make threema fields optional
* add missing fields to wecom + make url optional: secret, corp_id, agent_id, msg_type, to_user
* change separators for email address to match https://github.com/grafana/alerting/blob/f5fde7b9a4b73e8687e50aedf78773981f9d7a11/receivers/email/config.go#L50-L58
* support string for webhook's maxAlerts If integration is edited via UI it will contain string that represents number
* add upload_image to popover
Copy file name to clipboardExpand all lines: docs/resources/contact_point.md
+21-6
Original file line number
Diff line number
Diff line change
@@ -116,6 +116,7 @@ Optional:
116
116
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
117
117
-`message` (String) The templated content of the message. Defaults to ``.
118
118
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
119
+
-`title` (String) The templated content of the title.
119
120
-`use_discord_username` (Boolean) Whether to use the bot account's plain username instead of "Grafana." Defaults to `false`.
120
121
121
122
Read-Only:
@@ -155,6 +156,7 @@ Optional:
155
156
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
156
157
-`message` (String) The templated content of the message.
157
158
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
159
+
-`title` (String) The templated content of the title.
158
160
159
161
Read-Only:
160
162
@@ -171,8 +173,14 @@ Required:
171
173
172
174
Optional:
173
175
176
+
-`api_version` (String) The API version to use when contacting the Kafka REST Server. Supported: v2 (default) and v3. Defaults to `v2`.
177
+
-`cluster_id` (String) The Id of cluster to use when contacting the Kafka REST Server. Required api_version to be 'v3'
178
+
-`description` (String) The templated description of the Kafka message.
179
+
-`details` (String) The templated details to include with the message.
174
180
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
181
+
-`password` (String, Sensitive) The password to use when making a call to the Kafka REST Proxy
175
182
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
183
+
-`username` (String) The user name to use when making a call to the Kafka REST Proxy
176
184
177
185
Read-Only:
178
186
@@ -249,6 +257,7 @@ Optional:
249
257
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
250
258
-`sound` (String) The sound associated with the notification.
251
259
-`title` (String) The templated title of the message.
260
+
-`upload_image` (Boolean) Whether to send images in the notification or not. Default is true. Requires Grafana to be configured to send images in notifications.
252
261
253
262
Read-Only:
254
263
@@ -333,8 +342,12 @@ Required:
333
342
334
343
Optional:
335
344
345
+
-`disable_notifications` (Boolean) When set users will receive a notification with no sound.
336
346
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
347
+
-`disable_web_page_preview` (Boolean) When set it disables link previews for links in the message.
337
348
-`message` (String) The templated content of the message.
349
+
-`parse_mode` (String) Mode for parsing entities in the message text. Supported: None, Markdown, MarkdownV2, and HTML. HTML is the default.
350
+
-`protect_content` (Boolean) When set it protects the contents of the message from forwarding and saving.
338
351
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
339
352
340
353
Read-Only:
@@ -348,15 +361,15 @@ Read-Only:
348
361
Required:
349
362
350
363
-`api_secret` (String, Sensitive) The Threema API key.
351
-
-`description` (String, Sensitive) The templated description of the message.
352
364
-`gateway_id` (String) The Threema gateway ID.
353
365
-`recipient_id` (String) The ID of the recipient of the message.
354
-
-`title` (String, Sensitive) The templated title of the message.
355
366
356
367
Optional:
357
368
369
+
-`description` (String) The templated description of the message.
358
370
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
359
371
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
372
+
-`title` (String) The templated title of the message.
360
373
361
374
Read-Only:
362
375
@@ -411,16 +424,18 @@ Read-Only:
411
424
<aid="nestedblock--wecom"></a>
412
425
### Nested Schema for `wecom`
413
426
414
-
Required:
415
-
416
-
-`url` (String, Sensitive) The WeCom webhook URL.
417
-
418
427
Optional:
419
428
429
+
-`agent_id` (String) Agent ID added to the request payload when using APIAPP.
430
+
-`corp_id` (String) Corp ID used to get token when using APIAPP.
420
431
-`disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
421
432
-`message` (String) The templated content of the message to send.
433
+
-`msg_type` (String) The type of them message. Supported: markdown, text. Default: text.
434
+
-`secret` (String, Sensitive) The secret key required to obtain access token when using APIAPP. See https://work.weixin.qq.com/wework_admin/frame#apps to create APIAPP.
422
435
-`settings` (Map of String, Sensitive) Additional custom properties to attach to the notifier. Defaults to `map[]`.
423
436
-`title` (String) The templated title of the message to send.
437
+
-`to_user` (String) The ID of user that should receive the message. Multiple entries should be separated by '|'. Default: @all.
438
+
-`url` (String, Sensitive) The WeCom webhook URL. Required if using GroupRobot.
0 commit comments