Skip to main content

Feishu

The feishu channel establishes a WebSocket long connection with Feishu servers to receive bot events and send replies. No public IP required, just configure the app credentials.

What it supports​

  • WebSocket long connection for receiving Feishu events
  • no public IP required
  • text message replies

Quick Start​

  1. Create Feishu App

    Go to Feishu Open Platform and create an enterprise self-built app.

  2. Enable Bot Capability

    Add bot capability to the app and configure message event subscriptions.

  3. Get Credentials

    Obtain App ID and App Secret.

  4. Configure Verification

    If event encryption is enabled, configure verification_token and encrypt_key.

  5. Configure MushroomAgent

    Set environment variable or config file to enable the Feishu channel.

Config​

channels:
  feishu:
    enabled: true
    app_id: "cli_xxx"
    app_secret: "xxx"
    verification_token: "xxx"
    encrypt_key: "xxx"

Environment variables:

  • FEISHU_APP_ID
  • FEISHU_APP_SECRET
  • FEISHU_VERIFICATION_TOKEN
  • FEISHU_ENCRYPT_KEY

Permission Requirements​

Configure this permission on Feishu Open Platform:

  • im:message - read and send messages

Good fit for​

  • Feishu group bots
  • Feishu DM assistants
  • internal knowledge Q&A and workflow bots