Skip to content

Commit ba3da73

Browse files
ysyneuysyneu
committed
update english im integration docs
1 parent b81a002 commit ba3da73

5 files changed

Lines changed: 450 additions & 321 deletions

File tree

‎flashduty/en/1. On-call/8. Integrations/8.3 IM integration/8.3.1 Feishu(Lark) Integration Guide.md‎

Lines changed: 91 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,149 @@
11
---
2-
title: Contributing to our documentation — Meilisearch documentation
3-
description: The Meilisearch documentation is open-source. Learn how to help make it even better.
4-
sidebarDepth: 3
2+
title: "Feishu/Lark Integration"
3+
description: "By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark."
4+
date: "2025-05-19T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/en/flashduty/lark-integration-guide?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5"
56
---
7+
By integrating a custom Feishu/Lark application, you can receive and respond to alerts within Feishu/Lark.
68

7-
Integrate with Feishu(Lark) custom application to receive and respond to alerts within Feishu/Lark.
9+
<div class="hide">
810

9-
<!--
10-
## Video Tutorial
11+
## Watch videos
1112
---
1213
<Video src="https://download.flashcat.cloud/flashduty/video/feishu.mp4"></Video>
13-
-->
14+
</div>
1415

15-
## I. Create Feishu/Lark Application
16+
## 1. Create Feishu/Lark application
1617
---
1718

18-
### 1. Create Custom Application
19+
### 1. Create a custom application
1920

20-
Visit [Feishu/Lark Developer Console](https://open.feishu.cn/app) to create an internal custom application. (For details, see Feishu/Lark development documentation - [Create Enterprise Custom Application](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac))
21+
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.
2122

22-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-1.png" alt="drawing" width="400"/>
23+
For details, see the Feishu/Lark development documentation [Create an internal custom application](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#132c1aac).
2324

24-
You can use the [Flashduty official icon](https://download.flashcat.cloud/flashcat_logo_circular.png) as the application icon.
25+
![2025-09-11-11-58-10](https://docs-cdn.flashcat.cloud/images/png/4d86df2305e788e1464b170835dec13d.png)
2526

26-
### 2. Copy Credentials
27+
### 2. Copy credential information
2728

28-
Go to the **Credentials & Basic Info** page, copy the `App ID` and `App Secret` for later use.
29+
Go to the **Credentials and Basic Information** page and copy the `App ID` and `App Secret` for later use.
2930

30-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-2.png" alt="drawing" width="800"/>
3131

32-
### 3. Copy Event Callback Token Information
32+
![2025-09-11-12-00-22](https://docs-cdn.flashcat.cloud/images/png/903780c245c7ff2119c9885bb4adf151.png)
3333

34-
Go to **Development Configuration - Events & Callbacks - Encryption Configuration** page, copy the `Encrypt Key` (recommended for better security) and `Verification Token` for later use.
34+
### 3. Copy the event callback Token information
3535

36-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-2.png" alt="drawing" width="800"/>
36+
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.
3737

38-
## II. Add Feishu/Lark Integration
38+
![2025-09-11-12-02-33](https://docs-cdn.flashcat.cloud/images/png/10870591ec4c450c6014119a6f2b6b84.png)
39+
40+
## 2. Add Feishu/Lark integration
3941
---
4042

41-
Return to Flashduty **Integration Center** page, select **Instant Messaging => Feishu/Lark**, fill in the `Name` and the previously copied `App ID`, `App Secret`, `Verification Token`, and `Encrypt Key`, then click save to create.
43+
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.
4244

43-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-4.png" alt="drawing" width="800"/>
45+
<img src="https://download.flashcat.cloud/feishu-app-integration-upsert-3.png" alt="drawing" width="800"/>
4446

45-
After creation, you'll see the newly added Feishu/Lark integration in the list. Click on the name to enter details, where you'll find the **Web Configuration** URL, **Redirect URL**, and **Message Card Request URL** information, which will be used in later steps.
47+
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.
4648

47-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-5.png" alt="drawing" width="800"/>
49+
![2025-09-11-14-23-52](https://docs-cdn.flashcat.cloud/images/png/bf2ae6f78c0637e8dfc7d46394e64fa5.png)
4850

49-
## III. Configure Feishu/Lark Application
51+
## 3. Configure Feishu/Lark application
5052
---
5153

52-
### 1. Enable and Configure Application Capabilities
53-
54-
1). Return to the Feishu/Lark Developer Console, enter the newly created application, go to **Add Capabilities - Add by Capability** page, and enable both **Web Application** and **Bot** capabilities.
54+
### 1. Enable and configure application capabilities
5555

56-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-6.png" alt="drawing" width="800"/>
56+
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.
5757

58-
2). Go to **Web Application** page, configure both `Desktop Homepage` and `Mobile Homepage` with the **Web Configuration** URL from the integration details.
58+
![2025-09-11-12-05-32](https://docs-cdn.flashcat.cloud/images/png/7f7a6417533dda0617e55a7729c3d18a.png)
5959

60-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-7.png" alt="drawing" width="800"/>
60+
2. Go to the **Web Application** page and configure the `Desktop Homepage` and `Mobile Homepage`, both using the **Web Configuration** address from the integration details.
6161

62-
(See Feishu/Lark development documentation - [Configure Application Homepage URL](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844))
62+
For details, see the Feishu/Lark development documentation [Configure application homepage address](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step1#8366b844).
6363

64-
3). Go to **Event Callbacks - Callback Configuration** page, configure the `Message Card Request URL` (using the **Message Card Request URL** from integration details) and add the callback.
64+
<img src="https://download.flashcat.cloud/feishu-self-app-web-config-1.png" alt="drawing" width="800"/>
6565

66-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-8.png" alt="drawing" width="800"/>
67-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-9.png" alt="drawing" width="800"/>
66+
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:
6867

69-
### 2. Add Redirect URL to Feishu/Lark Application
68+
- `card.action.trigger`
69+
- `card.action.trigger_v1`
7070

71-
Go to **Security Settings** page, configure the `Redirect URL` using the **Redirect URL** from integration details.
71+
![2025-09-11-11-25-32](https://docs-cdn.flashcat.cloud/images/png/948b242146b641671795600473401439.png)
7272

73-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-10.png" alt="drawing" width="800"/>
73+
### 2. Add redirect URL to Feishu/Lark application
7474

75-
(See Feishu/Lark development documentation - [Configure Redirect URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533))
75+
Go to the **Security Settings** page and configure the `Redirect URL` using the **Redirect URL** from the integration details.
7676

77-
### 3. Request Application Permissions
77+
For details, see the Feishu/Lark development documentation [Configure redirect URL](https://open.feishu.cn/document/uYjL24iN/uYjN3QjL2YzN04iN2cDN?lang=zh-CN#c863e533).
7878

79-
Go to **Permission Management** page, request `im:chat` and `im:message` permissions. These permissions will allow the application to access its group chat information and send messages to groups or individuals.
79+
![2025-09-11-11-29-49](https://docs-cdn.flashcat.cloud/images/png/263849573db72f0ca6253b5d8572da94.png)
8080

81-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-11.png" alt="drawing" width="800"/>
82-
83-
## IV. Application Publication and Usage
84-
---
81+
### 3. Apply for application permissions
8582

86-
After completing the above steps, proceed with application publication and usage. The application can be used after administrator approval.
87-
Note: **Available Range** needs special configuration, recommended for **All Employees**.
83+
Go to the **Permission Management** page and apply for the following permissions for the group application created in the previous steps:
8884

89-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-12.png" alt="drawing" width="800"/>
85+
- `im:chat`: Get and update group information
86+
- `im:message`: Get and send single chat and group messages
87+
- `contact:user.id:readonly`: Get user ID by phone number or email (for configuring war rooms)<span id="war-room-scope"></span>
9088

91-
See Feishu/Lark development documentation - [Application Publication and Usage](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4).
9289

93-
Once published, you can access the application via mobile/PC client. First-time access requires login and account association (Feishu/Lark 《-》 Flashduty), subsequent uses will be login-free.
90+
![2025-09-11-11-32-48](https://docs-cdn.flashcat.cloud/images/png/ad17a4dab9767327f86a33728ecf659f.png)
9491

95-
1. Mobile: Access the web application through Feishu/Lark > Workspace > Search application name > Open application.
96-
2. PC: Access the web application through Feishu/Lark > Workspace > Search application name > Open application.
97-
98-
## V. Common Issues
92+
## 4. Application release and usage
9993
---
10094

101-
1. **Unable to deliver messages to individuals**, operation record shows `Application Not Associated`?
102-
103-
- Go to Feishu/Lark > Workspace > Search application name > Open application, complete one login and account association (Feishu/Lark 《-》 Flashduty) for the system to obtain user identity for message pushing
95+
After completing all the above configurations, please release the application. It can be used after administrator approval.
10496

105-
2. **Message card buttons not working or showing errors**?
97+
For details, see the Feishu/Lark development documentation [Application release and usage](https://open.feishu.cn/document/uYjL24iN/uMTMuMTMuMTM/development-guide/step-4).
10698

107-
- Ensure account association is completed. Go to Feishu/Lark > Workspace > Search application name > Open application, complete one login and account association (Feishu/Lark 《-》 Flashduty). If already logged in, try clicking the top-right menu to switch accounts and re-login to bind the account
108-
- Ensure sufficient licenses are purchased. You can check license usage in Console > Billing Center
99+
> To ensure that everyone can use the application, adjust the application **visibility** to all employees before releasing the application.
109100
110-
3. **Empty Feishu/Lark group chat list in escalation rule**?
101+
![2025-09-11-12-07-30](https://docs-cdn.flashcat.cloud/images/png/f8262ed8cf28064c20e27d1a0c2afad6.png)
111102

112-
- Go to Feishu/Lark, select group chat conversation, add the created Flashduty bot as shown below:
113-
- Return to the escalation rule configuration page, refresh and reselect the group chat list
114103

115-
<img alt="drawing" width="800" src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-13.png" />
116-
<img src="https://download.flashcat.cloud/flashduty/doc/en/feishu/feishu-14.png" alt="drawing" width="800"/>
104+
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.
117105

118-
4. **Feishu/Lark Custom Application API Limits:** [Feishu/Lark Documentation](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/platform-updates-/custom-app-api-call-limit)
106+
- **Mobile**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
107+
- **PC**: Access via Feishu/Lark → Workplace → Search for application name → **Open Application** to use the web application.
119108

120-
**Call Volume Limits:**
109+
## 5. Configure war room
121110

122-
| Feishu/Lark Version | Total Calls/Month | Reset Time |
123-
| :----------: | :--: | :----: |
124-
|Basic Free Version|10,000 calls|1st of each month|
125-
|Other Versions|Unlimited|-|
111+
> Ensure the application has been authorized with the [additional permissions](#war-room-scope) required for the war room feature.
126112
127-
**Frequency Control Limits:**
113+
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.
128114

129-
| Scenario | Limit |
130-
| :----------: | :--: |
131-
|All APIs|Maximum 50 calls/second per application|
132-
|Message Sending API|Maximum 1000 calls/minute per application|
133-
|Group Bot Webhook|Maximum 100 calls/minute|
134-
|Sending messages to the same user or group|Maximum 5 calls/second|
115+
## 6. FAQ
116+
---
135117

136-
**Note:** Messages cannot be pushed normally when exceeding limits, please use notification channels reasonably
118+
1. **Messages cannot be delivered to individuals, and the operation log shows `app not linked`?**
119+
- 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.
120+
2. **Message card buttons are unresponsive or show errors?**
121+
- 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.
122+
- Ensure you have purchased sufficient licenses. You can check the license usage in Console → **Billing Center**.
123+
3. **The Feishu/Lark group chat list in escalation rules is empty?**
124+
- Go to Feishu/Lark and add the created Flashduty bot to the specified group chat.
125+
- Return to the escalation rule configuration page, refresh and reselect the group chat list.
126+
127+
<img alt="drawing" width="800" src="https://download.flashcat.cloud/feishu-self-app-invite-to-chat.jpeg" />
128+
<img src="https://download.flashcat.cloud/feishu-self-app-notify-rule.png" alt="drawing" width="800"/>
129+
4. **Feishu/Lark custom application API limits?**
130+
- **Call volume limits:**
131+
132+
| **Feishu/Lark Version** | **Total Calls/Month** | **Refresh Time** |
133+
| :---: | :---: | :---: |
134+
| Basic Free | 10,000 | 1st of each month |
135+
| Other Versions | Unlimited | - |
136+
137+
- **Rate limits:**
138+
139+
| **Scenario** | **Limit** |
140+
| :---: | :--- |
141+
| All APIs | Max 50 calls/second per app |
142+
| Send message APIs | Max 1000 calls/minute per app |
143+
| Group bot webhook | Max 100 calls/minute |
144+
| Send to same user or group | Max 5 calls/second |
145+
146+
> 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.
147+
5. **Why is the war room feature not working as expected?**
148+
- Please check again whether you have configured the [required permissions](#war-room-scope) for the war room feature.
149+
- Please refer to the **FAQ** section of the Flashduty [War Room Introduction](https://docs.flashcat.cloud/en/flashduty/war-room?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).

0 commit comments

Comments
 (0)