FieldShortcut Channel for OpenClaw

OpenClaw Channel plugin for FieldShortcut (Feishu Bitable integration via Nchan WebSocket).

Overview

This plugin wraps a channel for OpenClaw to send and receive messages to/from FieldShortcut through Nchan WebSocket. It enables OpenClaw AI Gateway to process tasks submitted from Feishu Bitable shortcuts.

Architecture

flowchart LR
    subgraph Feishu["飞书多维表格"]
        A1["指令列<br/>(任务输入)"]
        A2["结果列<br/>(结果输出)"]
    end

    subgraph Backend["FieldShortcut Backend"]
        B1["API Server"]
        B2["Nchan Pub/Sub"]
    end

    subgraph Plugin["OpenClaw Plugin<br/>(This Package)"]
        C1["FieldShortcutClient<br/>(WebSocket Connection)"]
        C2["Channel Handler"]
    end

    subgraph AI["OpenClaw AI"]
        D1["Agent Router"]
        D2["AI Models"]
    end

    A1 --"提交任务"--> B1
    B1 --"Publish"--> B2
    B2 --"WebSocket"--> C1
    C1 --"Dispatch"--> C2
    C2 --> D1
    D1 --> D2
    D2 --"Response"--> C2
    C2 --"Send Result"--> B2
    B2 --"Return"--> B1
    B1 --"返回结果"--> A2

Installation

Prerequisites

Install OpenClaw CLI first (see OpenClaw Getting Started):

pnpm add -g openclaw@latest

Install Plugin

openclaw plugins install fieldshortcut@latest

Expected output:

🦞 OpenClaw 2026.1.29 (a5b4d22) — We ship features faster than Apple ships calculator updates.

Downloading fieldshortcut@latest…
Extracting /var/folders/.../fieldshortcut-1.0.0.tgz…
Installing to /Users/.../.openclaw/extensions/fieldshortcut…
Installing plugin dependencies…
Installed plugin: fieldshortcut
Restart the gateway to load plugins.

Configuration

Run the channel configuration wizard:

openclaw channels add

Follow these steps:

1. Select Yes to enter configuration
2. Select FieldShortcut from the channel list
3. Configure the following:
   • Nchan server URL: https://fieldshortcut.com
   • Bot App ID: Your bot's app ID (create via FieldShortcut web interface)
   • Bot App Secret: Your bot's app secret
4. Select Finish to save

Bot Registration

Before configuring, create a Bot through the FieldShortcut web interface:

1. Log in to your FieldShortcut account
2. Navigate to OpenClaw settings
3. Click "Create Bot" to generate your app_id and app_secret

Plugin Structure

src/
├── index.ts      # Plugin entry point
├── channel.ts    # Channel plugin definition
├── client.ts     # Nchan WebSocket client
├── gateway.ts    # Message gateway with reconnection
├── bot.ts        # Message handler for AI dispatch
├── types.ts      # TypeScript type definitions
├── runtime.ts    # Runtime API management
├── logger.ts     # Logging utilities
└── monitor.ts    # Provider monitor (legacy)

Message Types

Task Message (from FieldShortcut)

{
  type: 'task',
  channel: 'fieldshortcut',
  timestamp: '2024-01-01T00:00:00Z',
  data: {
    task_id: 'unique-task-id',
    task: 'Analyze this data...',
    timestamp: '2024-01-01T00:00:00Z',
    bot_app_id: 'bot-xxxxxxxxxx'
  }
}

Result Message (to FieldShortcut)

{
  type: 'result',
  channel: 'fieldshortcut',
  timestamp: '2024-01-01T00:00:00Z',
  data: {
    task_id: 'unique-task-id',
    result: 'AI response text',
    timestamp: '2024-01-01T00:00:00Z',
    finished: true
  }
}

Development

# Install dependencies
npm install

# Build TypeScript
npm run build

# Watch mode
npm run dev

# Run tests
npm test

License

MIT