Skip to content

Commit b863657

Browse files
committed
update docs
2 parents ca9579b + 185784e commit b863657

2 files changed

Lines changed: 86 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ date: "2023-12-18T10:00:00+08:00"
7272
请你严格依照 @polish_instructions.md 的要求,对文档 @your_doc_name 进行润色。
7373
```
7474

75+
<<<<<<< HEAD
76+
完成润色后,可在 VSCode / Cursor 中打开文档,然后在文档 tab 页中右击,点击 `格式化文档`
77+
78+
=======
7579
完成润色后,可在 VSCode / Cursor 中打开文档,然后在文档 tab 页中右击,点击 `格式化文档`
7680

7781
- i18n

flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.52 WecomAlert Integration.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,88 @@ The system will generate a unique Wecom alert integration URL for you. This URL
5959

6060
By default, the system always creates new alerts for each message, but you can switch to these modes:
6161

62+
**Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.
63+
64+
- You need to fill in at least one **trigger** rule
65+
- You must set up regex extraction rules for Alert Key. The system uses this field to find historical alerts for updates or closure. **If regex extraction fails, the system will use the message title to generate an Alert Key** to ensure alerts won't be lost due to configuration errors
66+
- You can choose whether to discard messages when none of the rules match
67+
68+
Configuration example:
69+
70+
- Receive all messages, close the alert when the message content contains **RESOLVED**, otherwise trigger a new alert
71+
- Extract Alert Key from messages using the rule **/(.*)/**.
72+
73+
74+
### Notes
75+
- Wecom alert integration URL only supports Text and Markdown message types; other message types cannot be received
76+
- Flashduty will generate a default alert title: "Wecom robot Alert , If you need to change the title, you can customize it using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines)"
77+
78+
## Severity Mapping
79+
---
80+
81+
Currently, all alerts pushed to Flashduty through the Wecom integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
82+
83+
---
84+
title: "Wecom Alert Integration"
85+
description: "Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom"
86+
date: "2025-05-19T10:00:00+08:00"
87+
url: "https://docs.flashcat.cloud/en/flashduty/Wecom-alert-integration-guide"
88+
---
89+
90+
Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom.
91+
92+
<div class="hide">
93+
94+
## Operation Steps
95+
---
96+
97+
### Create Wecom Alert Integration
98+
99+
You can obtain a Wecom alert integration address through either of these two methods:
100+
101+
#### Using Dedicated Integration
102+
103+
Choose this method when you don't need to route alert events to different channels. It's simpler and recommended.
104+
105+
<details>
106+
<summary>Expand</summary>
107+
108+
1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
109+
2. Select the **Integration** tab, click **Add Integration** to enter the integration page
110+
3. Choose **Wecom Alert** integration and click **Save** to generate a card
111+
4. Click the generated card to view the **Wecom Alert Integration URL**, copy it for later use, and you're done
112+
113+
</details>
114+
115+
#### Using Shared Integration
116+
117+
Choose this method when you need to route alerts to different channels based on the alert event's payload information.
118+
119+
<details>
120+
<summary>Expand</summary>
121+
122+
1. Go to the Flashduty console, select **Integration Center => Alert Events** to enter the integration selection page
123+
2. Select **Wecom Alert** integration:
124+
- **Integration Name**: Define a name for the current integration
125+
- **Message Type**: Select Wecom alert message type, currently only Text and Markdown are supported
126+
- **Push Mode**: Choose when to trigger or recover alerts for Wecom notifications
127+
3. Copy the **Wecom Alert Integration URL** for later use
128+
4. Configure the default route and select the corresponding channel (after integration creation, you can go to `Routes` to configure more routing rules)
129+
5. Done
130+
131+
</details>
132+
</div>
133+
134+
### Customize Wecom Alert Integration
135+
136+
#### Wecom Alert Integration URL
137+
138+
The system will generate a unique Wecom alert integration URL for you. This URL is compatible with Wecom robot message protocol. When platforms only support Wecom robot channels, you can use this URL to receive corresponding messages.
139+
140+
#### Push Mode
141+
142+
By default, the system always creates new alerts for each message, but you can switch to these modes:
143+
62144
**Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.
63145

64146
- You need to fill in at least one **trigger** rule

0 commit comments

Comments
 (0)