๐ฌ Feishu Integration
๐ค Who it's for: Companies using Feishu / Lark
โฑ๏ธ Read time: ~6 minutes
๐ก In one line: Integrate YingClaw into your Feishu workflow โ your AI assistant is always within reach.
Connect YingClaw to Feishu (Lark compatible) with two receive modes โ WebSocket (long-lived connection) and Webhook (HTTP callback) โ to flexibly adapt to different network environments.
Overviewโ
YingClaw offers two Feishu integration modes:
- WebSocket Mode: Long-lived real-time push, no public IP needed (recommended)
- Webhook Mode: Traditional HTTP callback for environments with a public IP
| Scenario | Description |
|---|---|
| ๐ผ Team Collaboration | @ the Bot in Feishu groups for help |
| ๐ Approval Notifications | Automatic alerts on approval status changes |
| ๐ข Message Push | Scheduled task results pushed to Feishu |
Setupโ
1. Get Feishu App Credentialsโ
Go to Feishu Open Platform and create an internal enterprise app to get:
- App ID: Your application's unique identifier
- App Secret: Your application's secret key
2. Configure in YingClawโ
Log into the YingClaw Web Console, go to "Channels", enable Feishu:
| Parameter | Description |
|---|---|
app_id | App ID from Feishu Open Platform |
app_secret | App Secret from Feishu Open Platform |
encrypt_key | Message encryption key (optional) |
verification_token | Event verification token (optional) |
receive_mode | Receive mode: websocket (recommended) or webhook |
port | Listening port for webhook mode, default 9898 |
allowed_users | User allowlist, * means all users |
3. Choose Receive Modeโ
WebSocket Mode (recommended):
- No public IP or callback URL needed
- Real-time push with low latency
- Suitable for most deployment environments
Webhook Mode:
- Requires a public callback URL
- Suitable for server deployments with an existing public IP
- Requires manual port configuration
4. Start the Channelโ
After saving, YingClaw automatically establishes the connection and begins receiving messages.
Message Interactionโ
Private Chatโ
Employees send messages directly to the Feishu Bot. YingClaw responds in real time, supporting:
- ๐ฌ Intelligent conversation and knowledge Q&A
- ๐ Data analysis and visualization
- ๐ Document collaboration and editing
- โฐ Schedule and task management
Group Chatโ
Add the Bot to a Feishu group, then @ mention it to trigger a response. YingClaw auto-adapts reply language based on locale (Chinese / English / Japanese).
User Allowlistโ
channels:
feishu:
allowed_users:
- "user_abc123" # Only specific users
# - "*" # Allow all users
Notesโ
- WebSocket mode is recommended for most deployments โ no public IP needed
- Webhook mode requires the firewall to allow the configured port
- Encryption key and verification token are optional security enhancements
Next Stepsโ
- ๐ฌ Learn about ๐ฌ WeChat Integration
- ๐ Set up ๐ DingTalk Integration
- ๐ Back to Documentation