flashduty-knowledge-base 1.3.2 → 1.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -1
- package/dist/en.d.ts +1 -0
- package/dist/esm/en.js +597 -377
- package/dist/esm/zh.js +578 -338
- package/dist/iife/en.js +573 -353
- package/dist/iife/zh.js +552 -312
- package/dist/zh.d.ts +1 -0
- package/package.json +1 -1
package/dist/iife/en.js
CHANGED
|
@@ -309,9 +309,8 @@ attachment_stripped = true
|
|
|
309
309
|
## Severity Mapping
|
|
310
310
|
---
|
|
311
311
|
|
|
312
|
-
Currently, all alerts pushed to Flashduty through email integration are set to Warning severity.
|
|
313
|
-
|
|
314
|
-
`,i=`---
|
|
312
|
+
Currently, all alerts pushed to Flashduty through the email integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
|
|
313
|
+
`,o=`---
|
|
315
314
|
title: "Nightingale/Flashcat Integration"
|
|
316
315
|
description: "Push alert events from Nightingale (n9e) or Flashcat to Flashduty via webhook. When an alert is triggered, send a trigger event to Flashduty; when an alert recovers, send a recovery event to Flashduty"
|
|
317
316
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -507,7 +506,7 @@ Nightingale/Flashcat to Flashduty alert severity mapping:
|
|
|
507
506
|
|
|
508
507
|
</details>
|
|
509
508
|
|
|
510
|
-
`,
|
|
509
|
+
`,i=`---
|
|
511
510
|
title: "Prometheus Integration Guide"
|
|
512
511
|
description: "Push Prometheus alert events to Flashduty through AlertManager using webhooks. When an alert is triggered, it sends a trigger event to Flashduty, and when the alert recovers, it sends a recovery event."
|
|
513
512
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -1370,7 +1369,7 @@ Alibaba Cloud Monitor event alert to Flashduty severity level mapping:
|
|
|
1370
1369
|
| WARNING | Warning | Warning |
|
|
1371
1370
|
| INFO | Info | Info |
|
|
1372
1371
|
|
|
1373
|
-
</div>`,
|
|
1372
|
+
</div>`,h=`---
|
|
1374
1373
|
title: "Alibaba Cloud Monitor CM Metrics Integration"
|
|
1375
1374
|
description: "Sync Alibaba Cloud Monitor alert events to Flashduty via webhook for automated alert noise reduction"
|
|
1376
1375
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -1595,7 +1594,7 @@ Alibaba Cloud SLS monitoring to Flashduty alert severity mapping:
|
|
|
1595
1594
|
| 2 | Info | Info |
|
|
1596
1595
|
|
|
1597
1596
|
</div>
|
|
1598
|
-
`,
|
|
1597
|
+
`,u={CustomAlert:t,Email:a,N9e:o,Prometheus:i,Grafana:s,Zabbix:r,UptimeKuma:l,AliyunARMS:d,AliyunCmEvent:c,AliyunCm:h,AliyunSLS:e,AWSCW:e,AzureMonitor:`---
|
|
1599
1598
|
title: "AWS CloudWatch Integration"
|
|
1600
1599
|
description: "Sync AWS CloudWatch alert events to Flashduty via webhook to achieve automated alert noise reduction"
|
|
1601
1600
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -4708,7 +4707,7 @@ Flashduty has already adapted webhook protocols for several commonly used ticket
|
|
|
4708
4707
|
## Implementation Protocol
|
|
4709
4708
|
---
|
|
4710
4709
|
|
|
4711
|
-
Please refer to the [Developer Documentation](https://developer.flashcat.cloud/en/flashduty/event-api/change-event) to complete the protocol development.
|
|
4710
|
+
Please refer to the [Developer Documentation](https://developer-en.flashcat.cloud/en/flashduty/event-api/change-event) to complete the protocol development.
|
|
4712
4711
|
|
|
4713
4712
|
## Best Practices
|
|
4714
4713
|
---
|
|
@@ -4812,558 +4811,662 @@ Please contact Flashduty if you wish to modify this mapping.
|
|
|
4812
4811
|
|
|
4813
4812
|
</div>
|
|
4814
4813
|
`,Lark:`---
|
|
4815
|
-
title:
|
|
4816
|
-
description:
|
|
4817
|
-
|
|
4818
|
-
|
|
4819
|
-
|
|
4820
|
-
Integrate with Feishu(Lark) custom application to receive and respond to alerts within Feishu/Lark.
|
|
4821
|
-
|
|
4822
|
-
<!--
|
|
4823
|
-
## Video Tutorial
|
|
4814
|
+
title: "Feishu/Lark Integration"
|
|
4815
|
+
description: "By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark."
|
|
4816
|
+
date: "2025-05-19T10:00:00+08:00"
|
|
4817
|
+
url: "https://docs.flashcat.cloud/en/flashduty/lark-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
|
|
4824
4818
|
---
|
|
4825
|
-
|
|
4826
|
-
-->
|
|
4819
|
+
By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark.
|
|
4827
4820
|
|
|
4828
|
-
##
|
|
4821
|
+
## 1. Create Feishu/Lark application
|
|
4829
4822
|
---
|
|
4830
4823
|
|
|
4831
|
-
### 1. Create
|
|
4824
|
+
### 1. Create a custom application
|
|
4832
4825
|
|
|
4833
|
-
Visit [Feishu/Lark Developer Console](https://open.feishu.cn/app)
|
|
4826
|
+
Visit [Feishu/Lark Developer Console](https://open.feishu.cn/app) and create an internal custom application. You can use the [official Flashduty icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the application icon.
|
|
4834
4827
|
|
|
4835
|
-
|
|
4828
|
+
For details, see the Feishu/Lark development documentation [Create an internal custom application](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac).
|
|
4836
4829
|
|
|
4837
|
-
|
|
4830
|
+
|
|
4831
|
+
### 2. Copy credential information
|
|
4838
4832
|
|
|
4839
|
-
|
|
4833
|
+
Go to the **Credentials and Basic Information** page and copy the \`App ID\` and \`App Secret\` for later use.
|
|
4840
4834
|
|
|
4841
|
-
Go to the **Credentials & Basic Info** page, copy the \`App ID\` and \`App Secret\` for later use.
|
|
4842
4835
|
|
|
4843
|
-
|
|
4836
|
+
|
|
4844
4837
|
|
|
4845
|
-
### 3. Copy
|
|
4838
|
+
### 3. Copy the event callback Token information
|
|
4846
4839
|
|
|
4847
|
-
Go to
|
|
4840
|
+
Go to Development Configuration → Events & Callbacks → **Encryption Strategy** page, generate and copy the \`Encrypt Key\` (recommended for better security) and \`Verification Token\` for later use.
|
|
4848
4841
|
|
|
4849
|
-
|
|
4842
|
+
|
|
4850
4843
|
|
|
4851
|
-
##
|
|
4844
|
+
## 2. Add Feishu/Lark integration
|
|
4852
4845
|
---
|
|
4853
4846
|
|
|
4854
|
-
Return to Flashduty **Integration Center** page, select
|
|
4847
|
+
Return to the Flashduty **Integration Center** page, select IM → **Feishu/Lark**, fill in the \`Name\` and the \`App ID\`, \`App Secret\`, \`Verification Token\`, and \`Encrypt Key\` copied in the previous step, then click **Save** to complete the creation.
|
|
4855
4848
|
|
|
4856
|
-
|
|
4849
|
+
After successful creation, you will see the added Feishu/Lark integration in the list. Click its name to enter the details page, where you can view the **Web Configuration** address, **Redirect URL**, and **Message Card Request URL**, which will be used in subsequent steps.
|
|
4857
4850
|
|
|
4858
|
-
|
|
4851
|
+
|
|
4859
4852
|
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
## III. Configure Feishu/Lark Application
|
|
4853
|
+
## 3. Configure Feishu/Lark application
|
|
4863
4854
|
---
|
|
4864
4855
|
|
|
4865
|
-
### 1. Enable and
|
|
4856
|
+
### 1. Enable and configure application capabilities
|
|
4866
4857
|
|
|
4867
|
-
1
|
|
4858
|
+
1. Return to the Feishu/Lark Developer Console, enter the created Feishu/Lark application, go to Add Application Capabilities → **Add by Capability** page, and enable both **Web Application** and **Bot** capabilities.
|
|
4868
4859
|
|
|
4869
|
-
|
|
4860
|
+
|
|
4870
4861
|
|
|
4871
|
-
2
|
|
4862
|
+
2. Go to the **Web app** page and configure the \`Desktop Homepage\` and \`Mobile Homepage\`, both using the **Web configuration** address from the integration details.
|
|
4872
4863
|
|
|
4873
|
-
|
|
4864
|
+
For details, see the Feishu/Lark development documentation [Configure application homepage address](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844).
|
|
4874
4865
|
|
|
4875
|
-
|
|
4866
|
+
|
|
4876
4867
|
|
|
4877
|
-
3
|
|
4868
|
+
3. Go to Event Callbacks → **Callback Configuration** page, configure the \`Subscription Method\` (using the **Message Card Request URL** from the integration details). Then, subscribe to the following two callback events:
|
|
4878
4869
|
|
|
4879
|
-
|
|
4880
|
-
|
|
4870
|
+
- \`im.message.receive_v1\`
|
|
4871
|
+
- \`im.chat.disbanded_v1\`
|
|
4881
4872
|
|
|
4882
|
-
|
|
4873
|
+
|
|
4883
4874
|
|
|
4884
|
-
|
|
4875
|
+
### 2. Add redirect URL to Feishu/Lark application
|
|
4885
4876
|
|
|
4886
|
-
|
|
4877
|
+
Go to the **Security Settings** page and configure the \`Redirect URL\` using the **Redirect URL** from the integration details.
|
|
4887
4878
|
|
|
4888
|
-
|
|
4879
|
+
For details, see the Feishu/Lark development documentation [Configure redirect URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533).
|
|
4889
4880
|
|
|
4890
|
-
|
|
4881
|
+
|
|
4891
4882
|
|
|
4892
|
-
|
|
4883
|
+
### 3. Apply for application permissions
|
|
4893
4884
|
|
|
4894
|
-
|
|
4885
|
+
Go to the **Permission Management** page and apply for the following permissions for the group application created in the previous steps:
|
|
4895
4886
|
|
|
4896
|
-
|
|
4897
|
-
|
|
4887
|
+
- \`im:chat\`: Get and update group information
|
|
4888
|
+
- \`im:message\`: Get and send single chat and group messages
|
|
4889
|
+
- \`contact:user.id:readonly\`: Get user ID by phone number or email (for configuring war rooms)<span id="war-room-scope"></span>
|
|
4890
|
+
|
|
4891
|
+
|
|
4898
4892
|
|
|
4899
|
-
|
|
4900
|
-
|
|
4893
|
+
## 4. Application release
|
|
4894
|
+
---
|
|
4901
4895
|
|
|
4902
|
-
|
|
4896
|
+
After completing all the above configurations, please release the application. It can be used after administrator approval.
|
|
4903
4897
|
|
|
4904
|
-
|
|
4898
|
+
For details, see the Feishu/Lark development documentation [Application release and usage](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4).
|
|
4905
4899
|
|
|
4906
|
-
|
|
4900
|
+
> To ensure that everyone can use the application, adjust the application **visibility** to all employees before releasing the application.
|
|
4907
4901
|
|
|
4908
|
-
|
|
4909
|
-
2. PC: Access the web application through Feishu/Lark > Workspace > Search application name > Open application.
|
|
4902
|
+
|
|
4910
4903
|
|
|
4911
|
-
## V. Common Issues
|
|
4912
|
-
---
|
|
4913
4904
|
|
|
4914
|
-
|
|
4905
|
+
After the application is released, you can access it via **mobile** or **PC**. The first access requires login to link your Feishu/Lark and Flashduty accounts. Subsequent access will be login-free.
|
|
4915
4906
|
|
|
4916
|
-
|
|
4907
|
+
- **Mobile**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
|
|
4908
|
+
- **PC**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
|
|
4917
4909
|
|
|
4918
|
-
|
|
4910
|
+
|
|
4919
4911
|
|
|
4920
|
-
|
|
4921
|
-
- Ensure sufficient licenses are purchased. You can check license usage in Console > Billing Center
|
|
4912
|
+
## 5. Configure war room
|
|
4922
4913
|
|
|
4923
|
-
|
|
4914
|
+
> Ensure the application has been authorized with the [additional permissions](#war-room-scope) required for the war room feature.
|
|
4924
4915
|
|
|
4925
|
-
|
|
4926
|
-
- Return to the escalation rule configuration page, refresh and reselect the group chat list
|
|
4916
|
+
After completing the previous steps, in the **Enhanced Features** module of the Flashduty integration configuration page, check **Enable War Room** to enable this feature without additional configuration.
|
|
4927
4917
|
|
|
4928
|
-
|
|
4929
|
-
|
|
4918
|
+
## 6. FAQ
|
|
4919
|
+
---
|
|
4930
4920
|
|
|
4931
|
-
|
|
4921
|
+
1. **Messages cannot be delivered to individuals, and the operation log shows \`app not linked\`?**
|
|
4922
|
+
- Go to Feishu/Lark → Workplace → Search for application name → **Open Application**, complete login once to link your Feishu/Lark and Flashduty accounts, so the system can obtain user identity for message push.
|
|
4923
|
+
2. **Message card buttons are unresponsive or show errors?**
|
|
4924
|
+
- Ensure the account has been linked. You can go to Feishu/Lark → Workplace → Search for application name → **Open Application** to complete login once. If you have already logged in, try clicking the menu in the upper right corner, switch accounts, and log in again to bind the account.
|
|
4925
|
+
- Ensure you have purchased sufficient licenses. You can check the license usage in Console → **Billing Center**.
|
|
4926
|
+
3. **The Feishu/Lark group chat list in escalation rules is empty?**
|
|
4927
|
+
- Go to Feishu/Lark and add the created Flashduty bot to the specified group chat.
|
|
4928
|
+
- Return to the escalation rule configuration page, refresh and reselect the group chat list.
|
|
4932
4929
|
|
|
4933
|
-
|
|
4930
|
+
|
|
4934
4931
|
|
|
4935
|
-
|
|
4936
|
-
|
|
4937
|
-
|Basic Free Version|10,000 calls|1st of each month|
|
|
4938
|
-
|Other Versions|Unlimited|-|
|
|
4932
|
+
4. **Feishu/Lark custom application API limits?**
|
|
4933
|
+
- **Call volume limits:**
|
|
4939
4934
|
|
|
4940
|
-
|
|
4935
|
+
| **Feishu/Lark Version** | **Total Calls/Month** | **Refresh Time** |
|
|
4936
|
+
| :---: | :---: | :---: |
|
|
4937
|
+
| Basic Free | 10,000 | 1st of each month |
|
|
4938
|
+
| Other Versions | Unlimited | - |
|
|
4941
4939
|
|
|
4942
|
-
|
|
4943
|
-
| :----------: | :--: |
|
|
4944
|
-
|All APIs|Maximum 50 calls/second per application|
|
|
4945
|
-
|Message Sending API|Maximum 1000 calls/minute per application|
|
|
4946
|
-
|Group Bot Webhook|Maximum 100 calls/minute|
|
|
4947
|
-
|Sending messages to the same user or group|Maximum 5 calls/second|
|
|
4940
|
+
- **Rate limits:**
|
|
4948
4941
|
|
|
4949
|
-
|
|
4942
|
+
| **Scenario** | **Limit** |
|
|
4943
|
+
| :---: | :--- |
|
|
4944
|
+
| All APIs | Max 50 calls/second per app |
|
|
4945
|
+
| Send message APIs | Max 1000 calls/minute per app |
|
|
4946
|
+
| Group bot webhook | Max 100 calls/minute |
|
|
4947
|
+
| Send to same user or group | Max 5 calls/second |
|
|
4948
|
+
|
|
4949
|
+
> After exceeding API call limits, the Feishu/Lark application will not be able to push messages normally. It is recommended to use notification channels reasonably. See [Feishu/Lark official documentation](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit) for details.
|
|
4950
|
+
5. **Why is the war room feature not working as expected?**
|
|
4951
|
+
- Please check again whether you have configured the [required permissions](#war-room-scope) for the war room feature.
|
|
4952
|
+
- Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).`,Dingtalk:`---
|
|
4950
4953
|
title: "Dingtalk Integration"
|
|
4951
|
-
description: "
|
|
4954
|
+
description: "By integrating a custom Dingtalk application, you can receive and respond to alerts within Dingtalk."
|
|
4952
4955
|
date: "2025-05-19T10:00:00+08:00"
|
|
4953
|
-
url: "https://docs.flashcat.cloud/en/flashduty/dingtalk-integration-guide"
|
|
4956
|
+
url: "https://docs.flashcat.cloud/en/flashduty/dingtalk-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
|
|
4954
4957
|
---
|
|
4955
4958
|
|
|
4956
|
-
|
|
4959
|
+
By integrating a custom Dingtalk application, you can receive and respond to alerts within Dingtalk.
|
|
4960
|
+
|
|
4961
|
+
> This document uses the new version of the Dingtalk Open Platform as an example.
|
|
4962
|
+
|
|
4963
|
+
|
|
4964
|
+
## I. Create Dingtalk Application and Add Dingtalk Integration
|
|
4957
4965
|
|
|
4958
|
-
**(This guide uses the new version of Dingtalk Open Platform as an example)**
|
|
4959
|
-
<!--
|
|
4960
|
-
## Video Tutorial
|
|
4961
|
-
---
|
|
4962
|
-
<Video src="https://download.flashcat.cloud/flashduty/video/dingding.mp4"></Video>
|
|
4963
|
-
-->
|
|
4964
|
-
## I. Create Dingtalk Application
|
|
4965
4966
|
---
|
|
4966
4967
|
|
|
4967
|
-
### 1. Create Custom Application
|
|
4968
|
+
### 1. Create a Custom Application
|
|
4969
|
+
|
|
4970
|
+
Visit the [Dingtalk Developer Console](https://open-dev.dingtalk.com/fe/app) → Application Development → **Internal Enterprise Development** to create an application.
|
|
4968
4971
|
|
|
4969
|
-
|
|
4972
|
+
For details, please refer to the Dingtalk development documentation [Create an in-house application-H5 micro-application](https://open.dingtalk.com/document/orgapp/microapplication-creation-and-release-process#title-ovn-666-1ty).
|
|
4970
4973
|
|
|
4971
|
-
|
|
4974
|
+
|
|
4972
4975
|
|
|
4973
|
-
You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png)
|
|
4976
|
+
You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the application icon.
|
|
4974
4977
|
|
|
4975
|
-
### 2. Copy Enterprise CorpId
|
|
4978
|
+
### 2. Copy the Enterprise \`CorpId\`
|
|
4976
4979
|
|
|
4977
|
-
Click on the enterprise in the
|
|
4980
|
+
Click on the enterprise avatar in the top right corner of the page and copy the \`CorpId\` from the dropdown menu.
|
|
4978
4981
|
|
|
4979
|
-
|
|
4982
|
+
|
|
4980
4983
|
|
|
4981
|
-
|
|
4984
|
+
Return to the Flashduty integration configuration page and fill in the corresponding \`CorpId\` in the form.
|
|
4982
4985
|
|
|
4983
|
-
|
|
4986
|
+
### 3. Copy Application Credential Information
|
|
4984
4987
|
|
|
4985
|
-
|
|
4988
|
+
Enter the application details interface you created, go to the Application Capability → **Credentials and Basic Information** page via the left menu bar, and copy the \`AgentId\`, \`Client ID\`, and \`Client Secret\`.
|
|
4989
|
+
|
|
4990
|
+
|
|
4991
|
+
|
|
4992
|
+
Return to the Flashduty integration configuration page and fill in the corresponding \`AgentId\`, \`Client ID\`, and \`Client Secret\` in the form.
|
|
4986
4993
|
|
|
4987
4994
|
### 4. Copy Event Subscription Information
|
|
4988
4995
|
|
|
4989
|
-
Go to
|
|
4996
|
+
Go to Development Configuration → **Events and Callbacks** page. Set the push method to \`HTTP Push\`, then click the button to generate an \`Encryption aes_key\` and a \`Signature Token\`, and copy them.
|
|
4990
4997
|
|
|
4991
|
-
|
|
4998
|
+
|
|
4992
4999
|
|
|
4993
|
-
|
|
5000
|
+
Return to the Flashduty integration configuration page, fill in the corresponding \`Encryption aes_key\` and \`Signature Token\` in the form, and click the **Save** button.
|
|
4994
5001
|
|
|
4995
|
-
|
|
5002
|
+
### 5. Configure Event Subscription
|
|
4996
5003
|
|
|
4997
|
-
|
|
4998
|
-
---
|
|
5004
|
+
Go to the Development Configuration → **Event Subscription** page.
|
|
4999
5005
|
|
|
5000
|
-
|
|
5006
|
+
Configure the **Event Subscription Request URL** using the \`Event Subscription Request URL\` from the Flashduty integration details. **Save** after configuration.
|
|
5001
5007
|
|
|
5002
|
-
|
|
5008
|
+
|
|
5003
5009
|
|
|
5004
|
-
|
|
5010
|
+
Below the **Save** button, select the three group session events: \`Group chat name is changed\`, \`Install the cool application in the group\`, and \`Uninstall the cool application in the group\`. Click **Save** after configuration.
|
|
5005
5011
|
|
|
5006
|
-
|
|
5012
|
+
|
|
5007
5013
|
|
|
5008
|
-
|
|
5009
|
-
---
|
|
5014
|
+
### 6. Add Application Capabilities
|
|
5010
5015
|
|
|
5011
|
-
|
|
5012
|
-
<img src="https://download.flashcat.cloud/flashduty/doc/en/ding/ding-7.png" alt="drawing" width="500"/>
|
|
5016
|
+
Create a Cool App. Go to Development Configuration → Add Application Capability → Cool App → **Cool App List** page, click the **Create Cool App** button, and select **Extend to group sessions**.
|
|
5013
5017
|
|
|
5014
|
-
|
|
5018
|
+
Enter the **Edit Cool App** page and complete the following steps:
|
|
5015
5019
|
|
|
5016
|
-
|
|
5020
|
+
1. Fill in the basic information. You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the icon.
|
|
5017
5021
|
|
|
5018
|
-
|
|
5022
|
+
|
|
5019
5023
|
|
|
5020
|
-
2.
|
|
5024
|
+
2. Configure the functional design. Select **Group Quick Access** and **Message Card** on the left. You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the group quick access icon. For the desktop and mobile access addresses, please copy the **Cool App Web URL** from the integration details.
|
|
5021
5025
|
|
|
5022
|
-
|
|
5026
|
+
|
|
5023
5027
|
|
|
5024
|
-
|
|
5028
|
+
3. Skip the third step of functional development, proceed to the fourth step **Preview & Release**, click the **Release** button and confirm.
|
|
5025
5029
|
|
|
5026
|
-
|
|
5030
|
+
### 7. Configure Bot and Message Push
|
|
5027
5031
|
|
|
5028
|
-
|
|
5032
|
+
Go to the Application Capability → **Bot** page, enable the bot configuration, fill in the name and upload an icon, then click **Save**. You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) for the icon.
|
|
5029
5033
|
|
|
5030
|
-
|
|
5034
|
+
|
|
5031
5035
|
|
|
5032
|
-
|
|
5036
|
+
### 8. Configure Application URLs
|
|
5033
5037
|
|
|
5034
|
-
|
|
5038
|
+
Go to the Application Capability → **Web Application** page.
|
|
5035
5039
|
|
|
5036
|
-
|
|
5040
|
+
Configure the **Application Homepage URL** and **PC Homepage URL** with the \`Application Homepage URL\` and \`PC Homepage URL\` from the Flashduty integration details. Click **Save** when done.
|
|
5037
5041
|
|
|
5038
|
-
|
|
5042
|
+
|
|
5039
5043
|
|
|
5040
|
-
|
|
5044
|
+
### 9. Apply for Application Permissions
|
|
5041
5045
|
|
|
5042
|
-
|
|
5046
|
+
Go to the Development Configuration → **Permissions** page and apply for the following permissions for the group application created in the previous steps:
|
|
5043
5047
|
|
|
5044
|
-
|
|
5048
|
+
- \`qyapi_chat_manage\`: Get group chat information
|
|
5049
|
+
- \`qyapi_robot_sendmsg\`: Send messages to group chats or individuals
|
|
5045
5050
|
|
|
5046
|
-
|
|
5051
|
+
|
|
5047
5052
|
|
|
5048
|
-
|
|
5053
|
+
## II. Configure War Room
|
|
5049
5054
|
|
|
5050
|
-
|
|
5055
|
+
> If you do not need to configure the War Room feature, you can skip this step and proceed directly to [**Application Release and Usage**](#publish).
|
|
5051
5056
|
|
|
5052
|
-
|
|
5057
|
+
<span id="war-room-scope"></span>
|
|
5053
5058
|
|
|
5054
|
-
|
|
5059
|
+
### 1. Apply for Application Permissions
|
|
5055
5060
|
|
|
5056
|
-
|
|
5061
|
+
Go to the Development Configuration → **Permissions** page and apply for the following permissions for the group application created in the previous steps:
|
|
5057
5062
|
|
|
5058
|
-
|
|
5063
|
+
- \`qyapi_chat_read\`: Get group chat information
|
|
5064
|
+
- \`qyapi_chat_base_read\`: Get group chat information
|
|
5065
|
+
- \`qyapi_get_member_by_mobile\`: Allows the current application to get Dingtalk user information based on mobile numbers to invite users to join group chats
|
|
5059
5066
|
|
|
5060
|
-
|
|
5067
|
+
|
|
5061
5068
|
|
|
5062
|
-
|
|
5063
|
-
|
|
5069
|
+
### 2. Configure Group Template
|
|
5070
|
+
|
|
5071
|
+
Go to Open Capability → **Scene Group** from the top menu bar of the Dingtalk Open Platform.
|
|
5072
|
+
|
|
5073
|
+
1. Configure **Group Bot**. Select **Bot** from the left menu bar, then click **Create group bot**.
|
|
5074
|
+
|
|
5075
|
+
> The **Group Bot** configured in this step and the **Application Bot** are two different concepts. The group bot is used to automatically create a group bot when a group chat is generated. The group bot and the application bot have different **Bot IDs**. To enable the War Room feature for Dingtalk, you must configure an additional **Group Bot**.
|
|
5076
|
+
|
|
5077
|
+
Fill in the group bot configuration. The **Message Callback URL**, **Message Callback Token**, and **Information Source Website** configurations have no practical effect in Flashduty's application scenario; you can configure them with any values that meet the requirements.
|
|
5078
|
+
|
|
5079
|
+
**Example Configuration**:
|
|
5080
|
+
|
|
5081
|
+
| **Configuration Item** | **Value** |
|
|
5082
|
+
| -------------- | --------------------------------------------------------------------------------- |
|
|
5083
|
+
| Bot Name | Flashduty |
|
|
5084
|
+
| Bot Avatar | [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) |
|
|
5085
|
+
| Introduction | Flashduty |
|
|
5086
|
+
| Message Preview Image | [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) |
|
|
5087
|
+
| Detailed Description | Flashduty message push bot. |
|
|
5088
|
+
| Message Callback URL | \`https://flashcat.cloud/\` |
|
|
5089
|
+
| Message Callback Token | \`token\` |
|
|
5090
|
+
| Information Source Website | \`https://flashcat.cloud/\` |
|
|
5091
|
+
|
|
5092
|
+
After completing the configuration, click **Create**, then click **Approve**. After the "Submission successful" pop-up appears in the top right corner, Dingtalk has automatically completed the approval of the group bot.
|
|
5093
|
+
|
|
5094
|
+
|
|
5095
|
+
|
|
5096
|
+
2. Configure **Group Template**. Select **Group Template** from the left menu bar, and click **Create group template**.
|
|
5097
|
+
|
|
5098
|
+
Set the **Enterprise Type** to \`Internal Enterprise\` and the **Optional Application** to the custom application created in the previous steps. Then, fill in the template information in the next step.
|
|
5099
|
+
|
|
5100
|
+
Introductory information such as **Template Name**, **Icon**, **Description**, **Copywriting Introduction**, **Template Description**, and **Image Introduction** will not affect the use of the group template feature; you can configure them with any values that meet the requirements.
|
|
5101
|
+
|
|
5102
|
+
**Example Configuration**:
|
|
5103
|
+
|
|
5104
|
+
| **Configuration Item** | **Value** |
|
|
5105
|
+
| ---------- | --------------------------------------------------------------------------------- |
|
|
5106
|
+
| Template Name | Flashduty War Room |
|
|
5107
|
+
| Icon | [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) |
|
|
5108
|
+
| Description | Create a war room for active incidents with one click. |
|
|
5109
|
+
| Copywriting Introduction | Create a war room for active incidents with one click. |
|
|
5110
|
+
| Template Description | Create a war room for active incidents with one click. |
|
|
5111
|
+
| Image Introduction | [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) |
|
|
5064
5112
|
|
|
5065
|
-
|
|
5113
|
+
In the **Select Bot** configuration item, click **Select created bot** and choose the group bot created in the previous step. Keep other configuration items at their default settings. Finally, click **Save Edit**.
|
|
5066
5114
|
|
|
5067
|
-
|
|
5068
|
-
|
|
5115
|
+
|
|
5116
|
+
|
|
5069
5117
|
|
|
5070
|
-
|
|
5118
|
+
In the **Fill in grayscale group** step, click **Create grayscale group**, then click **Publish grayscale**.
|
|
5071
5119
|
|
|
5072
|
-
|
|
5073
|
-
|
|
5120
|
+
Finally, click **Group Template** in the left menu bar again, then click to enter the group template you just created. Click **Submit for Review**, and after Dingtalk automatically approves it, finally click **Publish**.
|
|
5121
|
+
|
|
5122
|
+
3. In the published group template details page, copy the **Template ID** and **Bot ID**.
|
|
5123
|
+
|
|
5124
|
+
|
|
5125
|
+
|
|
5126
|
+
Return to the Flashduty integration configuration page, fill in the corresponding \`Template ID\` and \`Bot ID\` in the form, and click the **Save** button.
|
|
5127
|
+
|
|
5128
|
+
<span id="publish"></span>
|
|
5129
|
+
|
|
5130
|
+
## III. Application Release and Usage
|
|
5074
5131
|
|
|
5075
|
-
## V. Common Issues
|
|
5076
5132
|
---
|
|
5077
|
-
1. **Cannot deliver messages to individuals**, operation record shows \`Application Not Associated\`?
|
|
5078
5133
|
|
|
5079
|
-
|
|
5134
|
+
After completing the above steps, go to Application Release → **Version Management and Release**, create a new version, and publish it.
|
|
5135
|
+
|
|
5136
|
+
> To ensure that everyone can use the application, you need to adjust the **Visible Scope** of the application to all employees before publishing.
|
|
5080
5137
|
|
|
5081
|
-
|
|
5138
|
+
|
|
5082
5139
|
|
|
5083
|
-
|
|
5084
|
-
|
|
5140
|
+
After the application is published, you can access it via the **mobile client** or **PC client**. The first time you access it, you need to log in and associate your Dingtalk and Flashduty accounts. Subsequent uses will be login-free.
|
|
5141
|
+
|
|
5142
|
+
- **Mobile Client**: Access the web application through Dingtalk → Workbench → Search for application name → **Open Application**.
|
|
5143
|
+
- **PC Client**: Access the web application through Dingtalk → Workbench → Search for application name → **Open Application**.
|
|
5144
|
+
|
|
5145
|
+
## IV. FAQ
|
|
5146
|
+
|
|
5147
|
+
---
|
|
5085
5148
|
|
|
5086
|
-
|
|
5149
|
+
1. **Why can't messages be delivered to individuals, and the operation record shows \`app not linked\`?**
|
|
5150
|
+
- Go to Dingtalk → Workbench → Search for application name → **Open Application**, and complete a login to associate your Dingtalk and Flashduty accounts. The system needs to obtain your user identity to push messages.
|
|
5151
|
+
2. **Why are the message card buttons not working or showing an error?**
|
|
5152
|
+
- Go to Dingtalk → Workbench → Search for application name → **Open Application**, and complete a login to associate your Dingtalk and Flashduty accounts. If you have already logged in, try clicking the menu in the upper right corner, switching accounts, and logging in again to bind your account.
|
|
5153
|
+
- Ensure you have purchased enough licenses. You can check your used license status in Console → [**Billing Center**](https://console.flashcat.cloud/wallet).
|
|
5154
|
+
3. **Why is the Dingtalk group chat list in the escalation rule empty?**
|
|
5155
|
+
- Go to Dingtalk, select a group chat session, and install the Cool App. Otherwise, the group chat list cannot be obtained.
|
|
5087
5156
|
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
- If still unable to get the group chat list, try uninstalling the Cool App from the group and repeat the above steps. If it still doesn't work, please contact customer or dedicated technical support
|
|
5157
|
+
|
|
5158
|
+
|
|
5091
5159
|
|
|
5092
|
-
|
|
5160
|
+
- Return to the escalation rule configuration page, refresh, and reselect the group chat list.
|
|
5161
|
+
- If you still cannot get the group chat list, try uninstalling the Cool App in the group and then repeating the above steps. If the problem persists, please contact customer or dedicated technical support.
|
|
5093
5162
|
|
|
5094
|
-
|
|
5163
|
+
4. **Why is the War Room feature not working as expected?**
|
|
5164
|
+
- Please double-check if you have configured the [required permissions](#war-room-scope) for the application's War Room feature.
|
|
5165
|
+
- Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5) document.
|
|
5095
5166
|
|
|
5096
|
-
|
|
5167
|
+
5. **Dingtalk Custom Application API Call Limits**
|
|
5097
5168
|
|
|
5098
|
-
|
|
|
5099
|
-
| :----------: |
|
|
5100
|
-
|Standard|10,000|20|1st of each month|
|
|
5101
|
-
|Professional|500,000|40|1st of each month|
|
|
5102
|
-
|
|
|
5169
|
+
| **Dingtalk Version** | **Total Calls/Month** | **QPS** | **Refresh Time** |
|
|
5170
|
+
| :----------: | :-------------: | :-----: | :----------: |
|
|
5171
|
+
| Standard | 10,000 | 20 | 1st of each month |
|
|
5172
|
+
| Professional | 500,000 | 40 | 1st of each month |
|
|
5173
|
+
| Exclusive | 5,500,000 | 60 | 1st of each month |
|
|
5103
5174
|
|
|
5104
|
-
|
|
5105
|
-
`,Wecom:`---
|
|
5175
|
+
> After exceeding the API call limit, the Dingtalk application will not be able to push messages normally. It is recommended to use notification channels reasonably. For details, see the [official Dingtalk documentation](https://open.dingtalk.com/document/orgapp/descriptions-about-adjusting-limit-and-frequency-of-api-calls?spm=ding_open_doc.document.0.0.6f6b21d9WtkxJI).`,Wecom:`---
|
|
5106
5176
|
title: "WeCom Integration"
|
|
5107
|
-
description: "
|
|
5177
|
+
description: "By integrating a WeCom application, you can receive and respond to alerts within WeCom."
|
|
5108
5178
|
date: "2025-05-19T10:00:00+08:00"
|
|
5109
|
-
url: "https://docs.flashcat.cloud/en/flashduty/wecom-integration-guide"
|
|
5179
|
+
url: "https://docs.flashcat.cloud/en/flashduty/wecom-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
|
|
5110
5180
|
---
|
|
5111
5181
|
|
|
5112
|
-
|
|
5182
|
+
By integrating a WeCom application, you can receive and respond to alerts within WeCom.
|
|
5113
5183
|
|
|
5114
|
-
|
|
5115
|
-
## Video Guide
|
|
5116
|
-
---
|
|
5117
|
-
<Video src="https://download.flashcat.cloud/flashduty/video/wechat.mp4"></Video>
|
|
5118
|
-
-->
|
|
5184
|
+
This document supports both [integrating third-party applications](#third-party) and [integrating custom enterprise applications](#self).
|
|
5119
5185
|
|
|
5120
|
-
## I. Install the Application
|
|
5121
|
-
---
|
|
5122
5186
|
|
|
5123
|
-
|
|
5187
|
+
> You only need to configure one of the two methods: **Integrate third-party application** or **Integrate custom application**.
|
|
5124
5188
|
|
|
5125
|
-
<
|
|
5189
|
+
<span id="third-party"></span>
|
|
5126
5190
|
|
|
5127
|
-
|
|
5191
|
+
## 1. Integrate third-party application
|
|
5128
5192
|
|
|
5129
|
-
|
|
5193
|
+
---
|
|
5130
5194
|
|
|
5131
|
-
|
|
5195
|
+
> As a WeCom service provider, Flashduty offers a long-term free version of the Flashduty application. This application requires WeCom API permissions to function (passwordless login + message sending).
|
|
5196
|
+
>
|
|
5197
|
+
> This license currently supports **up to 60 days** free of charge. After exceeding this usage period, Flashduty needs to purchase a WeCom license for you to continue using it.
|
|
5132
5198
|
|
|
5133
|
-
|
|
5199
|
+
1. Visit [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#apps), go to Application Management → **Applications** page, and click **Add Third-party Application**.
|
|
5134
5200
|
|
|
5135
|
-
|
|
5201
|
+
|
|
5136
5202
|
|
|
5137
|
-
|
|
5203
|
+
2. Enter \`Flashduty\` in the search bar, and click the **Add** button after finding the application.
|
|
5138
5204
|
|
|
5139
|
-
|
|
5205
|
+
|
|
5140
5206
|
|
|
5141
|
-
|
|
5142
|
-
---
|
|
5207
|
+
3. Modify the application **visibility range**. It is recommended to select all employees or specific department nodes to avoid needing to modify when new enterprise members are added. Then click **Agree to the above authorization and add** to complete the installation.
|
|
5143
5208
|
|
|
5144
|
-
|
|
5209
|
+
|
|
5145
5210
|
|
|
5146
|
-
|
|
5147
|
-
- Verify if you've correctly configured the \`Corp ID\`
|
|
5211
|
+
4. Visit [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#apps), go to **My Enterprise** page, and obtain the \`Enterprise ID\`.
|
|
5148
5212
|
|
|
5149
|
-
|
|
5213
|
+
|
|
5150
5214
|
|
|
5151
|
-
|
|
5152
|
-
- First-time access requires login, choose member account - password or SSO, successful login completes account linking between \`Flashduty\` and \`WeCom\`
|
|
5153
|
-
- Subsequent access will be passwordless
|
|
5215
|
+
5. Return to the Flashduty integration configuration page, fill in the \`Enterprise ID\` obtained in the previous step, and click **Save** to complete the integration.
|
|
5154
5216
|
|
|
5155
|
-
|
|
5217
|
+
<span id="self"></span>
|
|
5156
5218
|
|
|
5157
|
-
|
|
5158
|
-
- Go to channel details page - escalation rule, select WeCom integration in personal channels to complete notification setup
|
|
5159
|
-
- Supports customizing WeCom notification content through template management page. Note: **Custom area supports maximum 8 lines**, excess content will be truncated by WeCom
|
|
5219
|
+
## 2. Integrate custom enterprise application
|
|
5160
5220
|
|
|
5161
|
-
|
|
5221
|
+
---
|
|
5162
5222
|
|
|
5163
|
-
|
|
5223
|
+
1. Visit [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#apps), go to Application Management → **Applications** page, and click **Create Application**.
|
|
5164
5224
|
|
|
5165
|
-
-
|
|
5166
|
-
- Click \`Start Processing\` to set alert status to \`In Progress\`
|
|
5167
|
-
- Click \`Close Directly\` to set alert status to \`Closed\`
|
|
5168
|
-
- Click \`Snooze 2h\` to snooze the alert for 2 hours, click \`...\` in top-right corner for more snooze options
|
|
5225
|
+
|
|
5169
5226
|
|
|
5170
|
-
|
|
5227
|
+
2. Configure **Application Logo**, **Application Name**, and **Application Visibility Range**.
|
|
5171
5228
|
|
|
5172
|
-
-
|
|
5173
|
-
- Flashduty requests card content updates when alert status changes
|
|
5174
|
-
- When alert status changes frequently, updates might fail due to update limit, use refresh button for one additional update opportunity
|
|
5229
|
+
|
|
5175
5230
|
|
|
5176
|
-
|
|
5231
|
+
3. Return to the Flashduty integration configuration page and select whether WeCom is a \`non-private deployment version\` based on your actual situation.
|
|
5177
5232
|
|
|
5178
|
-
|
|
5179
|
-
- Try keyboard shortcut \`ctrl\` + \`command\` + \`shift\` + \`d\` to enable debug mode, then select \`Debug - Browser & WebView Related - Open in System Browser\` to change link opening behavior. Use the same shortcut to exit debug mode and retain settings
|
|
5233
|
+
If your WeCom is a private deployment version, you need to fill in the \`Endpoint\` in the configuration page. This address needs to be accessible by the Flashduty service. You may consider setting up **whitelist authorization** for it.
|
|
5180
5234
|
|
|
5181
|
-
|
|
5235
|
+
4. Visit [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#apps), go to **My Enterprise** page, obtain the \`Enterprise ID\`, and fill it in the Flashduty integration configuration page.
|
|
5182
5236
|
|
|
5183
|
-
|
|
5184
|
-
`,Slack:`---
|
|
5185
|
-
title: "Slack Integration"
|
|
5186
|
-
description: "Integrate with Slack to receive and respond to alerts within Slack"
|
|
5187
|
-
date: "2025-05-19T10:00:00+08:00"
|
|
5188
|
-
url: "https://docs.flashcat.cloud/en/flashduty/slack-integration-guide"
|
|
5189
|
-
---
|
|
5237
|
+
5. Return to [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#apps), go to **Application Management** page, click on the application you created to enter the details page. Obtain the \`AgentId\` from the page and fill it in the Flashduty integration configuration page.
|
|
5190
5238
|
|
|
5191
|
-
|
|
5239
|
+
6. On the application details page, obtain the \`Secret\` and fill it in the Flashduty integration configuration page.
|
|
5192
5240
|
|
|
5193
|
-
|
|
5194
|
-
---
|
|
5241
|
+
7. On the application details page, go to **Web Authorization and JS-SDK** page, click **Set Trusted Domain**, and configure **Callback domain for application OAuth 2.0 web authorization** as required.
|
|
5195
5242
|
|
|
5196
|
-
|
|
5243
|
+
> The trusted domain needs to point to Flashduty's backend address \`{api_host}\` (can be achieved through CNAME or proxy forwarding).
|
|
5244
|
+
>
|
|
5245
|
+
> For trusted domain requirements, see the official WeCom documentation [《Internal Development Domain Configuration Guide》](https://open.work.weixin.qq.com/wwopen/common/readDocument/40754).
|
|
5197
5246
|
|
|
5198
|
-
|
|
5247
|
+
|
|
5199
5248
|
|
|
5200
|
-
|
|
5249
|
+
Return to the Flashduty integration configuration page, fill in this domain, and complete the verification.
|
|
5201
5250
|
|
|
5202
|
-
|
|
5251
|
+
8. On the application details page, go to **Receive Messages** page and **Set API Reception**. Click **Random Generation** for both \`Token\` and \`EncodingAESKey\`, then copy and save the generated values.
|
|
5203
5252
|
|
|
5253
|
+
|
|
5204
5254
|
|
|
5205
|
-
|
|
5206
|
-
|
|
5255
|
+
Return to the Flashduty integration configuration page, fill in the saved \`Token\` and \`EncodingAESKey\`, and click **Save** to complete the integration.
|
|
5256
|
+
|
|
5257
|
+
9. Copy the \`Callback Address\` from the Flashduty integration details page, return to the **Receive Messages** page in WeCom. In the **API Reception** settings, fill in the \`Callback Address\` and the \`Token\` and \`EncodingAESKey\` saved in the previous step, then click **Save**.
|
|
5207
5258
|
|
|
5208
|
-
|
|
5209
|
-
- Adding the app to a channel requires Step 1 \`Install App\` to complete without errors
|
|
5210
|
-
- In the Slack channel, run \`/invite @FlashDuty\`. A message saying \`has joined\` or \`has been added by xx to xxx\` indicates successful addition
|
|
5259
|
+
|
|
5211
5260
|
|
|
5212
|
-
|
|
5213
|
-
- Add the app authorizer to the public channel
|
|
5214
|
-
- Or follow \`Common Issue 1\` to add the app to the channel
|
|
5261
|
+
## 3. Configure war room
|
|
5215
5262
|
|
|
5216
|
-
|
|
5217
|
-
- Try again, as there might be communication issues between the server and Slack causing authorization problems. Return to the add integration page and retry
|
|
5218
|
-
- If the error persists, contact customer support
|
|
5263
|
+
---
|
|
5219
5264
|
|
|
5220
|
-
|
|
5221
|
-
- Try again, as there might be communication issues when FlashDuty attempts to obtain the permanent authorization code. Return to the add integration page and retry
|
|
5222
|
-
- If the error persists, contact customer support
|
|
5265
|
+
> The war room feature is only supported when **custom enterprise application** mode is enabled.
|
|
5223
5266
|
|
|
5224
|
-
|
|
5225
|
-
- Try again, as there might be issues with Slack service
|
|
5226
|
-
- If the error persists, contact customer support
|
|
5267
|
+
After completing the previous steps, in the **Enhanced Features** module of the Flashduty integration configuration page, check **Enable War Room** to enable this feature without additional configuration.
|
|
5227
5268
|
|
|
5228
|
-
|
|
5229
|
-
- Try again, as there might be communication timeout issues between the server and Slack
|
|
5230
|
-
- If the error persists, contact customer support
|
|
5269
|
+
## 4. FAQ
|
|
5231
5270
|
|
|
5232
|
-
|
|
5233
|
-
- Try again, as there might be server errors, such as the integration being disabled
|
|
5234
|
-
- If the error persists, contact customer support
|
|
5271
|
+
---
|
|
5235
5272
|
|
|
5236
|
-
|
|
5237
|
-
-
|
|
5238
|
-
-
|
|
5239
|
-
|
|
5240
|
-
|
|
5273
|
+
1. **After clicking the integration save button, the system reports \`authorize app first\`?**
|
|
5274
|
+
- Please check if you have completed the application installation steps. For example, can you see the Flashduty application in the WeCom workplace?
|
|
5275
|
+
- Please check if you have correctly configured the \`Corp ID\`.
|
|
5276
|
+
2. **How to complete account linking or message sending prompts \`app not linked\`?**
|
|
5277
|
+
- Log in to the WeCom client (both desktop and mobile are acceptable), go to **Workplace**, find and open the Flashduty application.
|
|
5278
|
+
- The first time you enter the application, you need to log in. Select your member account and log in successfully through password or single sign-on to complete the linking of your Flashduty account and WeCom account.
|
|
5279
|
+
- Subsequent entries to the application will automatically log in without a password.
|
|
5280
|
+
3. **How to send incident notifications?**
|
|
5281
|
+
- Before sending notifications, you must complete account linking as described in the previous question.
|
|
5282
|
+
- Enter the specified channel, navigate to \`Escalation Rules\` → **Personal Channels**, and select \`WeCom\` as the notification method.
|
|
5283
|
+
- Flashduty supports customizing WeCom notification content. You can go to the **Template Management** page to set custom templates. **The custom area can display up to 8 lines**, and excess content will be truncated by WeCom.
|
|
5284
|
+
|
|
5285
|
+
4. **How to handle alerts within WeCom?**
|
|
5286
|
+
- Click on the card message to directly enter the alert details page.
|
|
5287
|
+
- Click **Start Processing** to directly set the alert to \`Processing\` status.
|
|
5288
|
+
- Click **Close Directly** to directly set the alert to \`Closed\` status.
|
|
5289
|
+
- Click **Snooze for 2 hours** to directly snooze the alert for 2 hours. If you want to snooze for longer, click the \`...\` in the upper right corner of the card to see more snooze options.
|
|
5290
|
+
5. **Why does the card message provide a \`Status Refresh\` button?**
|
|
5291
|
+
- According to WeCom's restrictions, after one card interaction, it can only be updated once within 72 hours. Each button operation is considered an interaction.
|
|
5292
|
+
- When the alert status changes, Flashduty will request to update the card content.
|
|
5293
|
+
- When the alert status changes frequently, the card may not be updated in real-time due to exceeding the update limit. At this time, you can click the **Refresh** button to manually get a chance to update the card status.
|
|
5294
|
+
6. **On Mac desktop, how to set clicking card messages to open with the \`system default browser\`?**
|
|
5295
|
+
- Mac desktop uses WeCom's built-in browser to open links by default.
|
|
5296
|
+
- You can try using the shortcut \`ctrl\` + \`command\` + \`shift\` + \`d\` to enable debug mode, then select **Debug** → **Browser, WebView Related** → **Open Web Page with System Browser** to change how links are opened. Use the same shortcut to close debug mode, and the settings will be retained.
|
|
5297
|
+
7. **Incident notification failed with prompt \`WeCom license not activated\`?**
|
|
5298
|
+
- Please contact Flashduty customer service or your dedicated technical support to purchase and activate the license for you.
|
|
5299
|
+
8. **Why is the war room feature not working as expected?**
|
|
5300
|
+
- Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).`,Slack:`---
|
|
5301
|
+
title: "Slack Integration"
|
|
5302
|
+
description: "By integrating the Slack third-party application, you can receive and respond to alerts within Slack."
|
|
5241
5303
|
date: "2025-05-19T10:00:00+08:00"
|
|
5242
|
-
url: "https://docs.flashcat.cloud/en/flashduty/
|
|
5304
|
+
url: "https://docs.flashcat.cloud/en/flashduty/slack-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
|
|
5243
5305
|
---
|
|
5244
5306
|
|
|
5245
|
-
|
|
5307
|
+
By integrating the Slack third-party application, you can receive and respond to alerts within Slack.
|
|
5246
5308
|
|
|
5247
|
-
|
|
5248
|
-
---
|
|
5309
|
+
<span id="install-app"></span>
|
|
5249
5310
|
|
|
5250
|
-
|
|
5311
|
+
## 1. Install application
|
|
5251
5312
|
|
|
5252
|
-
|
|
5253
|
-
These steps must be completed by a Microsoft Teams administrator
|
|
5254
|
-
:::
|
|
5313
|
+
---
|
|
5255
5314
|
|
|
5256
|
-
|
|
5257
|
-
|
|
5315
|
+
1. Visit Flashduty Integration Center → IM → **Slack**, and click **Add**.
|
|
5316
|
+
2. On the redirected Slack page, select **Workspace** in the upper right corner, then click **Allow**.
|
|
5317
|
+
|
|
5318
|
+
3. Enter the data source name and click **Save**.
|
|
5258
5319
|
|
|
5259
|
-
|
|
5260
|
-
Go to **Microsoft Teams, navigate to [+Apps] - [Manage your apps] - [Upload an app] - [Upload an app to your org's app catalog]** and upload the FlashDutyBot.zip package
|
|
5320
|
+
## 2. Configure war room
|
|
5261
5321
|
|
|
5262
|
-
|
|
5322
|
+
After completing the previous steps, in the **Enhanced Features** module of the Flashduty integration configuration page, check **Enable War Room** to enable this feature without additional configuration.
|
|
5263
5323
|
|
|
5264
|
-
|
|
5265
|
-
Go to [Microsoft Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps), find the FlashDuty application, and adjust the application visibility to everyone (or your custom scope)
|
|
5324
|
+
## 3. FAQ
|
|
5266
5325
|
|
|
5267
|
-
|
|
5268
|
-
|
|
5269
|
-
|
|
5270
|
-
|
|
5326
|
+
---
|
|
5327
|
+
|
|
5328
|
+
1. **The private channel I want is not in the group chat list of escalation rules?**
|
|
5329
|
+
- Ensure the [**Install Application**](#install-app) step has been completed successfully without errors.
|
|
5330
|
+
- Enter the relevant Slack channel and execute the \`/invite @Flashduty\` command. When you see the prompt \`has joined\` or \`has been added by xxx to xxx\`, it means the addition was successful.
|
|
5331
|
+
2. **The public channel I want is not in the group chat list of escalation rules?**
|
|
5332
|
+
- Add the application authorizer to the public channel.
|
|
5333
|
+
- Refer to the method in **Question 1** to add the application to the channel.
|
|
5334
|
+
3. **Error after clicking the \`Allow\` button in installation step 2?**
|
|
5335
|
+
- Please retry. This may be due to abnormal communication between the server and Slack causing authorization failure. Please return to the add data source page and try again.
|
|
5336
|
+
- If the error persists after retrying, please contact customer service.
|
|
5337
|
+
4. **Error after clicking the \`Save\` button in installation step 3?**
|
|
5338
|
+
- Please retry. This may be due to abnormal communication between the Flashduty server and Slack when obtaining the permanent authorization code. Please return to the add data source page and try again.
|
|
5339
|
+
- If the error persists after retrying, please contact customer service.
|
|
5340
|
+
5. **Slack App prompts \`not_authed\` error?**
|
|
5341
|
+
- Please retry, this may be a temporary issue with Slack service.
|
|
5342
|
+
- If the error persists after retrying, please contact customer service.
|
|
5343
|
+
6. **Slack App prompts \`Operation timed out\` error?**
|
|
5344
|
+
- Please retry. This may be due to communication timeout between the server and Slack.
|
|
5345
|
+
- If the error persists after retrying, please contact customer service.
|
|
5346
|
+
7. **Slack App prompts \`This app responded with Status Code 500\` error?**
|
|
5347
|
+
- Please retry. This may be an error on the Flashduty server side (for example, the data source is closed).
|
|
5348
|
+
- If the error persists after retrying, please contact customer service.
|
|
5349
|
+
8. **Slack App prompts other unknown errors?**
|
|
5350
|
+
- Please retry.
|
|
5351
|
+
- If the error persists after retrying, please contact customer service to record and resolve new issues.
|
|
5352
|
+
9. **Why is the war room feature not working as expected?**
|
|
5353
|
+
- For previously authorized Slack IM integrations, you need to manually reauthorize Slack in the Flashduty integration configuration page to grant the application the additional permissions required for the war room feature.
|
|
5354
|
+
- Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).`,MicrosoftTeams:`---
|
|
5355
|
+
title: "Microsoft Teams Integration"
|
|
5356
|
+
description: "By integrating the Microsoft Teams third-party application, you can receive and respond to alerts within Microsoft Teams."
|
|
5357
|
+
date: "2025-05-19T10:00:00+08:00"
|
|
5358
|
+
url: "https://docs.flashcat.cloud/en/flashduty/microsoft-teams-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
|
|
5359
|
+
---
|
|
5360
|
+
By integrating the Microsoft Teams third-party application, you can receive and respond to alerts within Microsoft Teams.
|
|
5271
5361
|
|
|
5272
|
-
|
|
5273
|
-
|
|
5362
|
+
## 1. Install and update application
|
|
5363
|
+
---
|
|
5274
5364
|
|
|
5275
|
-
|
|
5365
|
+
The Microsoft Teams integration is currently in Beta. You need to complete the following operations before linking.
|
|
5276
5366
|
|
|
5277
|
-
### 3. Update Application
|
|
5278
5367
|
::: caution
|
|
5279
|
-
|
|
5368
|
+
This step needs to be completed by a Microsoft Teams administrator.
|
|
5280
5369
|
:::
|
|
5281
5370
|
|
|
5282
|
-
|
|
5283
|
-
|
|
5284
|
-
|
|
5371
|
+
### 1. Download application
|
|
5372
|
+
Download [FlashDutyBot-v1.0.3.zip](https://flashduty-docs.oss-cn-beijing.aliyuncs.com/docs/FlashdutyBot-v1.0.3.zip) to your local device.
|
|
5285
5373
|
|
|
5286
|
-
|
|
5374
|
+
### 2. Install application
|
|
5375
|
+
In Microsoft Teams, navigate to +Apps → Manage your apps → Upload an app → **Upload an app to your org's app catalog**, then upload the application package \`FlashDutyBot.zip\`.
|
|
5287
5376
|
|
|
5288
|
-
|
|
5289
5378
|
|
|
5290
|
-
|
|
5379
|
+
#### Configure application visibility
|
|
5380
|
+
Go to [Microsoft Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps), find the Flashduty application, and adjust the application visibility to everyone or your specified scope.
|
|
5291
5381
|
|
|
5292
|
-
|
|
5293
|
-
|
|
5294
|
-
|
|
5382
|
+
::: tip
|
|
5383
|
+
If the application status is "Blocked", please wait a moment and refresh the page or manually modify it.
|
|
5384
|
+
:::
|
|
5385
|
+
|
|
5295
5386
|
|
|
5296
|
-
### 1. Add FlashDuty Application to Target Team
|
|
5297
5387
|
|
|
5298
|
-
####
|
|
5299
|
-
|
|
5388
|
+
#### Check if successfully added
|
|
5389
|
+
After waiting a few minutes, organization members can find this application in +Apps → **Built for your org**.
|
|
5300
5390
|
|
|
5301
|
-
|
|
5302
5392
|
|
|
5303
|
-
|
|
5393
|
+
### 3. Update application
|
|
5304
5394
|
::: caution
|
|
5305
|
-
|
|
5395
|
+
If your installed application version is lower than 1.0.3, please follow this process to update.
|
|
5306
5396
|
:::
|
|
5307
5397
|
|
|
5308
|
-
|
|
5398
|
+
1. Go to [Microsoft Teams Admin Center](https://admin.teams.microsoft.com/policies/manage-apps), find and enter the Flashduty application details page.
|
|
5399
|
+
|
|
5309
5400
|
|
|
5310
|
-
|
|
5311
|
-
|
|
5401
|
+
2. Upload the new version \`FlashdutyBot.zip\`.
|
|
5402
|
+
|
|
5312
5403
|
|
|
5313
|
-
|
|
5404
|
+
3. Wait for the application version to update in the client (may take tens of minutes).
|
|
5405
|
+
|
|
5314
5406
|
|
|
5315
|
-
##
|
|
5407
|
+
## 2. Link Team
|
|
5408
|
+
---
|
|
5409
|
+
### 1. Add Flashduty application
|
|
5410
|
+
1. Find the Flashduty application in the app marketplace.
|
|
5411
|
+
> If there is no application, please contact your Microsoft Teams organization administrator.
|
|
5316
5412
|
|
|
5317
|
-
|
|
5413
|
+
|
|
5318
5414
|
|
|
5319
|
-
|
|
5320
|
-
|
|
5415
|
+
2. Add the application to the target Team.
|
|
5416
|
+
::: caution
|
|
5417
|
+
This step must select the General Channel of the target Team, otherwise incidents cannot be sent to the Team.
|
|
5418
|
+
:::
|
|
5321
5419
|
|
|
5322
|
-
|
|
5323
5421
|
|
|
5324
|
-
|
|
5422
|
+
### 2. Send link command
|
|
5423
|
+
In the Team, @Flashduty and send the command \`linkTeam {ID}\`, then click **Link Now**.
|
|
5325
5424
|
|
|
5326
|
-
|
|
5327
5426
|
|
|
5328
|
-
|
|
5329
|
-
|
|
5427
|
+
## 3. Link Chat
|
|
5428
|
+
---
|
|
5429
|
+
### 1. Add Flashduty application
|
|
5430
|
+
1. Find the Flashduty application in the app marketplace.
|
|
5431
|
+
> If there is no application, please contact your Microsoft Teams organization administrator.
|
|
5330
5432
|
|
|
5331
|
-
|
|
5332
5434
|
|
|
5333
|
-
|
|
5435
|
+
2. Add the application to the target Chat.
|
|
5334
5436
|
|
|
5335
|
-
|
|
5437
|
+
|
|
5336
5438
|
|
|
5337
|
-
|
|
5338
|
-
|
|
5439
|
+
### 2. Send link command
|
|
5440
|
+
In the Chat, @Flashduty and send the command \`linkChat {ID} {ChatName}\`, then click **Link Now**.
|
|
5339
5441
|
|
|
5340
|
-
|
|
5341
5443
|
|
|
5342
|
-
|
|
5343
|
-
|
|
5444
|
+
## 4. Link user
|
|
5445
|
+
---
|
|
5446
|
+
### 1. Add Flashduty application
|
|
5447
|
+
1. Find the Flashduty application in the app marketplace.
|
|
5448
|
+
> If there is no application, please contact your Microsoft Teams organization administrator.
|
|
5344
5449
|
|
|
5345
|
-
|
|
5346
|
-
Copy the command: linkUser {} and send it to the chat, then click Associate Now
|
|
5450
|
+
|
|
5347
5451
|
|
|
5348
|
-
|
|
5452
|
+
2. Click **Open Application**.
|
|
5349
5453
|
|
|
5350
|
-
|
|
5351
|
-
<details>
|
|
5352
|
-
<summary>Team or individual not receiving messages</summary>
|
|
5353
|
-
Please check if the teams and users are successfully associated in Integration Center => Instant Messaging => Microsoft Teams
|
|
5354
|
-
</details>
|
|
5454
|
+
|
|
5355
5455
|
|
|
5356
|
-
|
|
5357
|
-
|
|
5358
|
-
Please check in Integration Center => Instant Messaging => Microsoft Teams under Associated Teams and Associated Users
|
|
5359
|
-
</details>
|
|
5456
|
+
### 2. Send link command
|
|
5457
|
+
Copy and send the command \`linkUser {}\` to the chat, then click **Link Now**.
|
|
5360
5458
|
|
|
5361
|
-
|
|
5362
|
-
<summary>How to cancel associated teams and users</summary>
|
|
5363
|
-
Currently not supported
|
|
5364
|
-
</details>
|
|
5459
|
+
|
|
5365
5460
|
|
|
5366
|
-
|
|
5461
|
+
## 5. FAQ
|
|
5462
|
+
---
|
|
5463
|
+
|
|
5464
|
+
1. **Team or individual cannot receive messages?**
|
|
5465
|
+
- Please go to Integration Center → IM → **Microsoft Teams** to check if teams and users have been successfully linked.
|
|
5466
|
+
2. **How to view linked teams and users?**
|
|
5467
|
+
- Please go to Integration Center → IM → **Microsoft Teams** to view in **Linked Teams** and **Linked Users**.
|
|
5468
|
+
3. **How to cancel linked teams and users?**
|
|
5469
|
+
- This feature is not currently supported.`,AlertWebhook:`Configure alert webhooks to receive HTTP callbacks at your specified URL when alerts have specific actions (such as triggering or closing). The callback content includes the latest key information about the alert, allowing integration with your custom tools.
|
|
5367
5470
|
|
|
5368
5471
|
<span id="EventTypes"></span>
|
|
5369
5472
|
|
|
@@ -6234,7 +6337,36 @@ CloseTime | int64 | No | Close time, EndTime is alert recovery time, CloseTime i
|
|
|
6234
6337
|
{{jsonGet .Labels.rule_note "#(userId==7777)#.instanceId" }}
|
|
6235
6338
|
|
|
6236
6339
|
\`\`\`
|
|
6237
|
-
|
|
6340
|
+
|
|
6341
|
+
10. **How to Retrieve the Image URL via the Src Attribute of [Image](#Image)**
|
|
6342
|
+
- The imageSrcToURL function can be implemented, accepting parameters: $root and Src
|
|
6343
|
+
- If Src is an image_key from the Image Upload API, it should be converted into a short-term accessible URL
|
|
6344
|
+
- If Src is an accessible http/https address, the address should be returned directly
|
|
6345
|
+
- Dingtalk/Slack Apps employ this method to render images
|
|
6346
|
+
\`\`\`go
|
|
6347
|
+
{{ $root := . }}
|
|
6348
|
+
{{ range $i, $v := .Images }}
|
|
6349
|
+
{{ $imageURL := imageSrcToURL $root $v.Src }}
|
|
6350
|
+
{{ if $imageURL }}{{ end }}{{end}}
|
|
6351
|
+
\`\`\`
|
|
6352
|
+
|
|
6353
|
+
11. **How to Convert and Upload Images to a Third-Party Notification Platform**
|
|
6354
|
+
- The transferImage function can be implemented, accepting parameters: $root and Src
|
|
6355
|
+
- Src can be an image_key from the Image Upload API or an accessible http/https image URL
|
|
6356
|
+
- Image size must not exceed 10 MB
|
|
6357
|
+
- Supported image formats include JPG, JPEG, PNG, WEBP, GIF, BMP, ICO, TIFF, HEIC
|
|
6358
|
+
- Requires enabling the application permission to access and upload image or file resources
|
|
6359
|
+
- Lark/Feishu Apps employ this method to render images
|
|
6360
|
+
|
|
6361
|
+
\`\`\`go
|
|
6362
|
+
{{ $root := . }}
|
|
6363
|
+
{{ range $i, $v := .Images }}
|
|
6364
|
+
{{ $transferURL := transferImage $root $v.Src }}
|
|
6365
|
+
{{ if $transferURL }}{{ end }}
|
|
6366
|
+
{{ end }}
|
|
6367
|
+
\`\`\`
|
|
6368
|
+
|
|
6369
|
+
12. **How to use logical AND, OR, and other conditions for conditional rendering/content display judgment?**
|
|
6238
6370
|
|
|
6239
6371
|
\`\`\`
|
|
6240
6372
|
# Supported functions
|
|
@@ -6267,7 +6399,7 @@ CloseTime | int64 | No | Close time, EndTime is alert recovery time, CloseTime i
|
|
|
6267
6399
|
|
|
6268
6400
|
\`\`\`
|
|
6269
6401
|
|
|
6270
|
-
|
|
6402
|
+
13. **How do I find more functions and their usage examples?**
|
|
6271
6403
|
- Function list: https://github.com/flashcatcloud/sprig/blob/master/functions.go#L97
|
|
6272
6404
|
- Usage examples: Check corresponding _test.go files, e.g., date function test cases at https://github.com/flashcatcloud/sprig/blob/master/date_test.go
|
|
6273
6405
|
|
|
@@ -6280,10 +6412,15 @@ Below are specific instructions for each notification channel.
|
|
|
6280
6412
|
You need to configure \`Integration Center-Instant Message-Feishu\` integration first to send message cards. If custom content is not set, the system default template will be used, rendering all label information:
|
|
6281
6413
|
|
|
6282
6414
|
\`\`\`go
|
|
6283
|
-
{{if .
|
|
6284
|
-
{{if .Labels.resource}}**resource** : {{
|
|
6415
|
+
{{if .Labels.body_text}}{{.Labels.body_text}}{{else if .Description}}{{.Description}}{{end}}
|
|
6416
|
+
{{if .Labels.resource}}**resource** : {{(joinAlertLabels . "resource" ", ")}}{{end}}
|
|
6285
6417
|
{{range $k, $v := .Labels}}
|
|
6286
|
-
{{if not (in $k "resource" "body_text")}}**{{$k}}** : {{
|
|
6418
|
+
{{if not (in $k "resource" "body_text" "body_text_with_table")}}**{{$k}}** : {{$v}}{{end}}{{end}}
|
|
6419
|
+
{{ $root := . }}
|
|
6420
|
+
{{ range $i, $v := .Images }}
|
|
6421
|
+
{{ $transferURL := transferImage $root $v.Src }}
|
|
6422
|
+
{{ if $transferURL }}{{ end }}
|
|
6423
|
+
{{ end }}
|
|
6287
6424
|
\`\`\`
|
|
6288
6425
|
|
|
6289
6426
|
As shown below:
|
|
@@ -6330,6 +6467,10 @@ You need to configure \`Integration Center-Instant Message-Dingtalk\` integratio
|
|
|
6330
6467
|
{{if .Labels.resource}}**resource** : {{toHtml (joinAlertLabels . "resource" ", ")}}{{end}}
|
|
6331
6468
|
{{range $k, $v := .Labels}}
|
|
6332
6469
|
{{if not (in $k "resource" "body_text")}}**{{$k}}** : {{toHtml $v}}{{end}}{{end}}
|
|
6470
|
+
{{ $root := . }}
|
|
6471
|
+
{{ range $i, $v := .Images }}
|
|
6472
|
+
{{ $imageURL := imageSrcToURL $root $v.Src }}
|
|
6473
|
+
{{ if $imageURL }}{{ end }}{{ end }}
|
|
6333
6474
|
\`\`\`
|
|
6334
6475
|
|
|
6335
6476
|
As shown below:
|
|
@@ -6408,13 +6549,22 @@ As shown below:
|
|
|
6408
6549
|
|
|
6409
6550
|
## Slack App
|
|
6410
6551
|
---
|
|
6552
|
+
|
|
6411
6553
|
You need to configure \`Integration Center-Instant Message-Slack\` integration first to send message cards. If custom content is not set, the system default template will be used, rendering only common label information:
|
|
6412
6554
|
|
|
6413
6555
|
\`\`\`go
|
|
6414
|
-
{{if .
|
|
6415
|
-
{{if .Labels.resource}}*resource* : {{
|
|
6556
|
+
{{if .Labels.body_text}}{{.Labels.body_text}}{{else if .Description}}{{.Description}}{{end}}
|
|
6557
|
+
{{if .Labels.resource}}*resource* : {{(joinAlertLabels . "resource" ", ")}}{{end}}
|
|
6416
6558
|
{{range $k, $v := .Labels}}
|
|
6417
|
-
{{if not (in $k "resource" "body_text")}}*{{$k}}* : {{
|
|
6559
|
+
{{if not (in $k "resource" "body_text" "body_text_with_table")}}*{{$k}}* : {{$v}}{{end}}{{end}}
|
|
6560
|
+
{{ $root := . }}
|
|
6561
|
+
{{ range $i, $v := .Images }}
|
|
6562
|
+
{{ $imageURL := imageSrcToURL $root $v.Src }}
|
|
6563
|
+
{{ if $imageURL }}
|
|
6564
|
+
---
|
|
6565
|
+
|
|
6566
|
+
{{ end }}
|
|
6567
|
+
{{ end }}
|
|
6418
6568
|
\`\`\`
|
|
6419
6569
|
|
|
6420
6570
|
As shown below:
|
|
@@ -6426,6 +6576,7 @@ If you want to display only key label information, you can refer to the code seg
|
|
|
6426
6576
|
- We've listed some common labels, you can add or remove as needed
|
|
6427
6577
|
- Messages can be around 15000 characters long, content beyond this will be truncated
|
|
6428
6578
|
- In Slack app, the system will automatically remove empty rendered lines (due to non-existent labels), so you can configure freely
|
|
6579
|
+
- To display images, use three consecutive hyphens \`---\` to separate it from other content. The image syntax must begin with \`.
|
|
7669
7819
|
`,FeishuAlert:`---
|
|
7670
7820
|
title: "Feishu Alert Integration"
|
|
7671
7821
|
description: "Generate a unique Feishu robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Feishu"
|
|
@@ -7747,8 +7897,7 @@ By default, the system always creates new alerts for each message, but you can s
|
|
|
7747
7897
|
## Severity Mapping
|
|
7748
7898
|
---
|
|
7749
7899
|
|
|
7750
|
-
Currently, all alerts pushed to Flashduty through Feishu
|
|
7751
|
-
|
|
7900
|
+
Currently, all alerts pushed to Flashduty through the Feishu(lark) integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
|
|
7752
7901
|
`,VolcEngineDetect:`---
|
|
7753
7902
|
title: "Volcengine Cloud-Detect Alert Events"
|
|
7754
7903
|
description: "Sync Volcengine Cloud-Detect alert events to Flashduty via webhook for automated alert noise reduction"
|
|
@@ -7805,7 +7954,7 @@ Choose this method when you need to route alerts to different channels based on
|
|
|
7805
7954
|
### Step 1: Create Notification Object
|
|
7806
7955
|
1. Login to your \`Volcengine\` console, find \`Alert Manager\` in the \`Notify Object\` menu
|
|
7807
7956
|
2. Click \`System Integration\`, click \`Create System Integration\` or edit the existing endpoint
|
|
7808
|
-
3.
|
|
7957
|
+
3. In the edit page, enter Flashduty as the name and fill in the <span class='integration_url'>push URL</span> for the alert integration in the URL field.
|
|
7809
7958
|
5. Click \`OK\` to complete the configuration
|
|
7810
7959
|
|
|
7811
7960
|
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-1.png" />
|
|
@@ -7915,7 +8064,7 @@ The user used to access ServiceNow needs to have administrator roles.
|
|
|
7915
8064
|
|
|
7916
8065
|
1. On the user list page, find the newly created \`flashduty\` user and go to the configuration page.
|
|
7917
8066
|
2. In the edit page, click \`Set Password\` to set a password.
|
|
7918
|
-
3. Click \`Roles\` to add **
|
|
8067
|
+
3. Click \`Roles\` to add **personalize_dictionary and itil** roles (If custom field mapping configuration is not required, the personalize_dictionary permission does not need to be retained).
|
|
7919
8068
|
4. Click \`Update\` to update the configuration.
|
|
7920
8069
|
|
|
7921
8070
|
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/snow/snow-2.png" />
|
|
@@ -8212,4 +8361,75 @@ Go to the \`RUM\` - \`Application Details\` - \`Alert Settings\` page to enable
|
|
|
8212
8361
|
|
|
8213
8362
|
|
|
8214
8363
|
For more information, please refer to [RUM Issue Alerting](https://docs.flashcat.cloud/en/flashduty/rum/issue-alerting?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).
|
|
8215
|
-
|
|
8364
|
+
`,Cloudflare:`---
|
|
8365
|
+
title: "Cloudflare Alert Events"
|
|
8366
|
+
description: "Sync Cloudflaret alert events to Flashduty via webhook for automated alert noise reduction"
|
|
8367
|
+
date: "2024-07-05T10:00:00+08:00"
|
|
8368
|
+
url: "https://docs.flashcat.cloud/en/flashduty/Cloudflare-integration-guide"
|
|
8369
|
+
---
|
|
8370
|
+
|
|
8371
|
+
Sync Cloudflare alert events to Flashduty via webhook for automated alert noise reduction.
|
|
8372
|
+
|
|
8373
|
+
<div class="hide">
|
|
8374
|
+
|
|
8375
|
+
## In Flashduty
|
|
8376
|
+
---
|
|
8377
|
+
You can obtain an integration push URL through either of these two methods:
|
|
8378
|
+
|
|
8379
|
+
### Using Private Integration
|
|
8380
|
+
|
|
8381
|
+
Choose this method when you don't need to route alert events to different channels - it's simpler.
|
|
8382
|
+
|
|
8383
|
+
<details>
|
|
8384
|
+
<summary>Expand</summary>
|
|
8385
|
+
|
|
8386
|
+
1. Go to the Flashduty console, select **Channel**, and enter a channel's details page
|
|
8387
|
+
2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
|
|
8388
|
+
3. Choose **Cloudflare** integration and click **Save** to generate a card
|
|
8389
|
+
4. Click the generated card to view the **Push URL**, copy it for later use, and you're done
|
|
8390
|
+
|
|
8391
|
+
</details>
|
|
8392
|
+
|
|
8393
|
+
### Using Shared Integration
|
|
8394
|
+
|
|
8395
|
+
Choose this method when you need to route alerts to different channels based on the alert event payload.
|
|
8396
|
+
|
|
8397
|
+
<details>
|
|
8398
|
+
<summary>Expand</summary>
|
|
8399
|
+
|
|
8400
|
+
1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
|
|
8401
|
+
2. Select **Cloudflare** integration:
|
|
8402
|
+
- **Integration Name**: Define a name for this integration
|
|
8403
|
+
3. Configure the default route and select the corresponding channel (after the integration is created, you can go to \`Route\` to configure more routing rules)
|
|
8404
|
+
4. Click **Save** and copy the newly generated **push URL** for later use
|
|
8405
|
+
5. Done
|
|
8406
|
+
|
|
8407
|
+
</details>
|
|
8408
|
+
</div>
|
|
8409
|
+
|
|
8410
|
+
|
|
8411
|
+
## In Cloudflare
|
|
8412
|
+
---
|
|
8413
|
+
|
|
8414
|
+
<div class="md-block">
|
|
8415
|
+
|
|
8416
|
+
## 一、Create Notification Object
|
|
8417
|
+
1. Log in to the \`Cloudflare dashboard\` and select your account.
|
|
8418
|
+
2. Go to \`Notifications\` > \`Destinations\`.
|
|
8419
|
+
3. In the \`Webhooks\` card, select Create.
|
|
8420
|
+
4. In the edit page, enter Flashduty as the name and fill in the <span class='integration_url'>push URL</span> for the alert integration in the URL field.
|
|
8421
|
+
5. Select \`Save and Test\` to finish setting up your webhook.
|
|
8422
|
+
|
|
8423
|
+
After configuring the Webhook channel, you can use it in notification policies.
|
|
8424
|
+
|
|
8425
|
+
</dev>
|
|
8426
|
+
|
|
8427
|
+
## 二、Status Mapping
|
|
8428
|
+
|
|
8429
|
+
<div class="md-block">
|
|
8430
|
+
|
|
8431
|
+
Currently, all alerts pushed to Flashduty through the Cloudflare integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
|
|
8432
|
+
|
|
8433
|
+
</div>
|
|
8434
|
+
|
|
8435
|
+
`};n.FlashDocsEn=u})(window);
|