docs(notifications): document Rocket.Chat

Refs #3821
This commit is contained in:
Marcos Paulo Diniz committed 2026-08-02 01:59:58 -03:00
1 parent 5774cb0e06
commit 2e19b85a2d
4 files changed
+39 -3

No files matched your search

+1 -1
View File
@@ -151,7 +151,7 @@ Feel free to ask questions or share your ideas - we'd love to hear from you!
- Selective disk monitoring with mountpoint selection
- Incidents at a glance
- Status pages with 4 beautiful themes
- E-mail, Webhooks, Discord, Slack, PagerDuty, Matrix, Microsoft Teams, Telegram, Pushover, Twilio (SMS) notifications
- E-mail, Webhooks, Discord, Slack, PagerDuty, Matrix, Rocket.Chat, Microsoft Teams, Telegram, Pushover, Twilio (SMS) notifications
- Scheduled maintenance
- JSON query monitoring
- Multi-language support for Arabic, Chinese (Simplified), Chinese (Traditional, Taiwan), Czech, English, Finnish, French, German, Japanese, Portuguese (Brazil), Russian, Spanish, Thai, Turkish, Ukrainian, and Vietnamese
+28 -1
View File
@@ -34,7 +34,7 @@
},
{
"name": "notifications",
"description": "Notification channels (email, webhook, Slack, Discord, PagerDuty, Matrix, Teams, Telegram, Pushover, Twilio) and test alerts."
"description": "Notification channels (email, webhook, Slack, Discord, PagerDuty, Matrix, Rocket.Chat, Teams, Telegram, Pushover, Twilio) and test alerts."
},
{
"name": "maintenance-window",
@@ -879,6 +879,9 @@
{
"$ref": "#/components/schemas/WebhookNotification"
},
{
"$ref": "#/components/schemas/RocketChatNotification"
},
{
"$ref": "#/components/schemas/SlackNotification"
},
@@ -912,6 +915,7 @@
"mapping": {
"email": "#/components/schemas/EmailNotification",
"webhook": "#/components/schemas/WebhookNotification",
"rocket_chat": "#/components/schemas/RocketChatNotification",
"slack": "#/components/schemas/SlackNotification",
"discord": "#/components/schemas/DiscordNotification",
"pager_duty": "#/components/schemas/PagerDutyNotification",
@@ -1036,6 +1040,29 @@
"address": "https://example.com/hooks/checkmate"
}
},
"RocketChatNotification": {
"type": "object",
"properties": {
"notificationName": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": ["rocket_chat"]
},
"address": {
"type": "string",
"format": "uri"
}
},
"required": ["notificationName", "type", "address"],
"example": {
"notificationName": "Rocket.Chat alerts",
"type": "rocket_chat",
"address": "https://chat.example.com/hooks/integration-id/token"
}
},
"SlackNotification": {
"type": "object",
"properties": {
+2 -1
View File
@@ -39,7 +39,8 @@ export function getOpenApiSpec(): JsonObject {
{ name: "incidents", description: "Downtime incidents derived from monitor state changes, including filtering and CSV export." },
{
name: "notifications",
description: "Notification channels (email, webhook, Slack, Discord, PagerDuty, Matrix, Teams, Telegram, Pushover, Twilio) and test alerts.",
description:
"Notification channels (email, webhook, Slack, Discord, PagerDuty, Matrix, Rocket.Chat, Teams, Telegram, Pushover, Twilio) and test alerts.",
},
{ name: "maintenance-window", description: "Scheduled maintenance windows during which monitors do not generate incidents or alerts." },
{ name: "status-page", description: "Public status pages, their configuration, and the monitors they expose." },
+8
View File
@@ -23,6 +23,14 @@ const notificationVariantMeta: Record<string, { component: string; example: Reco
component: "WebhookNotification",
example: { notificationName: "Custom webhook", type: "webhook", address: "https://example.com/hooks/checkmate" },
},
rocket_chat: {
component: "RocketChatNotification",
example: {
notificationName: "Rocket.Chat alerts",
type: "rocket_chat",
address: "https://chat.example.com/hooks/integration-id/token",
},
},
slack: {
component: "SlackNotification",
example: { notificationName: "#alerts", type: "slack", address: "https://hooks.slack.com/services/T000/B000/XXXX" },