Móc nối

Hooks là các tập lệnh nhỏ chạy khi có điều gì đó xảy ra bên trong Gateway. Chúng có thể được phát hiện từ các thư mục và được kiểm tra bằng openclaw hooks. Gateway chỉ tải các hook nội bộ sau khi bạn bật hook hoặc cấu hình ít nhất một mục hook, gói hook, trình xử lý cũ, hoặc thư mục hook bổ sung.

Có hai loại hook trong OpenClaw:

• Hook nội bộ (trang này): chạy bên trong Gateway khi các sự kiện tác tử được kích hoạt, như /new, /reset, /stop, hoặc sự kiện vòng đời.
• Webhook: các endpoint HTTP bên ngoài cho phép hệ thống khác kích hoạt công việc trong OpenClaw. Xem Webhook.

Hook cũng có thể được đóng gói bên trong plugin. openclaw hooks list hiển thị cả hook độc lập và hook do plugin quản lý.

Bắt đầu nhanh

# List available hooksopenclaw hooks list # Enable a hookopenclaw hooks enable session-memory # Check hook statusopenclaw hooks check # Get detailed informationopenclaw hooks info session-memory

Loại sự kiện

Viết hook

Cấu trúc hook

Mỗi hook là một thư mục chứa hai tệp:

my-hook/├── HOOK.md          # Metadata + documentation└── handler.ts       # Handler implementation

Định dạng HOOK.md

---name: my-hookdescription: "Short description of what this hook does"metadata:  { "openclaw": { "emoji": "🔗", "events": ["command:new"], "requires": { "bins": ["node"] } } }--- # My Hook Detailed documentation goes here.

Trường metadata (metadata.openclaw):

Triển khai trình xử lý

const handler = async (event) => {  if (event.type !== "command" || event.action !== "new") {    return;  }   console.log(`[my-hook] New command triggered`);  // Your logic here   // Optionally send message to user  event.messages.push("Hook executed!");}; export default handler;

Mỗi sự kiện bao gồm: type, action, sessionKey, timestamp, messages (push để gửi cho người dùng), và context (dữ liệu dành riêng cho sự kiện). Ngữ cảnh hook của Plugin tác tử và công cụ cũng có thể bao gồm trace, một ngữ cảnh dấu vết chẩn đoán chỉ đọc tương thích W3C mà plugin có thể truyền vào nhật ký có cấu trúc để tương quan OTEL.

Điểm nổi bật về ngữ cảnh sự kiện

Sự kiện lệnh (command:new, command:reset): context.sessionEntry, context.previousSessionEntry, context.commandSource, context.workspaceDir, context.cfg.

Sự kiện tin nhắn (message:received): context.from, context.content, context.channelId, context.metadata (dữ liệu dành riêng cho provider bao gồm senderId, senderName, guildId). context.content ưu tiên phần thân lệnh không trống cho các tin nhắn giống lệnh, sau đó quay lại phần thân đến thô và phần thân chung; nó không bao gồm phần làm giàu chỉ dành cho tác tử như lịch sử luồng hoặc tóm tắt liên kết.

Sự kiện tin nhắn (message:sent): context.to, context.content, context.success, context.channelId.

Sự kiện tin nhắn (message:transcribed): context.transcript, context.from, context.channelId, context.mediaPath.

Sự kiện tin nhắn (message:preprocessed): context.bodyForAgent (phần thân đã làm giàu cuối cùng), context.from, context.channelId.

Sự kiện bootstrap (agent:bootstrap): context.bootstrapFiles (mảng có thể thay đổi), context.agentId.

Sự kiện vá phiên (session:patch): context.sessionEntry, context.patch (chỉ các trường đã thay đổi), context.cfg. Chỉ các client đặc quyền mới có thể kích hoạt sự kiện vá.

Sự kiện Compaction: session:compact:before bao gồm messageCount, tokenCount. session:compact:after thêm compactedCount, summaryLength, tokensBefore, tokensAfter.

command:stop quan sát người dùng phát hành /stop; đây là vòng đời hủy/lệnh, không phải cổng hoàn tất tác tử. Plugin cần kiểm tra câu trả lời cuối tự nhiên và yêu cầu tác tử thực hiện thêm một lượt nên dùng hook Plugin có kiểu before_agent_finalize thay thế. Xem Hook của Plugin.

Sự kiện vòng đời Gateway: gateway:shutdown bao gồm reason và restartExpectedMs và được kích hoạt khi quá trình tắt gateway bắt đầu. gateway:pre-restart bao gồm cùng ngữ cảnh nhưng chỉ được kích hoạt khi việc tắt là một phần của lần khởi động lại dự kiến và có giá trị restartExpectedMs hữu hạn được cung cấp. Trong khi tắt, mỗi lần chờ hook vòng đời là nỗ lực tối đa và có giới hạn để quá trình tắt tiếp tục nếu một trình xử lý bị treo.

Giữa sự kiện gateway:shutdown (hoặc gateway:pre-restart) và phần còn lại của chuỗi tắt, gateway cũng kích hoạt hook Plugin có kiểu session_end cho mọi phiên vẫn còn hoạt động khi tiến trình dừng. reason của sự kiện là shutdown cho một lần dừng SIGTERM/SIGINT thông thường và restart khi việc đóng được lên lịch như một phần của lần khởi động lại dự kiến. Quá trình xả này có giới hạn để trình xử lý session_end chậm không thể chặn tiến trình thoát, và các phiên đã được hoàn tất thông qua thay thế / đặt lại / xóa / Compaction sẽ bị bỏ qua để tránh kích hoạt hai lần.

Phát hiện hook

Hook được phát hiện từ các thư mục này, theo thứ tự mức ưu tiên ghi đè tăng dần:

1. Hook đóng gói sẵn: được phát hành cùng OpenClaw
2. Hook của Plugin: hook được đóng gói bên trong plugin đã cài đặt
3. Hook được quản lý: ~/.openclaw/hooks/ (do người dùng cài đặt, dùng chung giữa các workspace). Các thư mục bổ sung từ hooks.internal.load.extraDirs dùng chung mức ưu tiên này.
4. Hook workspace: <workspace>/hooks/ (theo từng tác tử, mặc định bị tắt cho đến khi được bật rõ ràng)

Hook workspace có thể thêm tên hook mới nhưng không thể ghi đè hook đóng gói sẵn, hook được quản lý, hoặc hook do plugin cung cấp có cùng tên.

Gateway bỏ qua phát hiện hook nội bộ khi khởi động cho đến khi hook nội bộ được cấu hình. Bật hook đóng gói sẵn hoặc hook được quản lý bằng openclaw hooks enable <name>, cài đặt gói hook, hoặc đặt hooks.internal.enabled=true để tham gia. Khi bạn bật một hook được đặt tên, Gateway chỉ tải trình xử lý của hook đó; hooks.internal.enabled=true, thư mục hook bổ sung, và trình xử lý cũ tham gia phát hiện rộng.

Gói hook

Gói hook là các gói npm export hook qua openclaw.hooks trong package.json. Cài đặt bằng:

openclaw plugins install <path-or-spec>

Spec npm chỉ đến từ registry (tên gói + phiên bản chính xác tùy chọn hoặc dist-tag). Spec Git/URL/tệp và khoảng semver bị từ chối.

Hook đóng gói sẵn

Bật bất kỳ hook đóng gói sẵn nào:

openclaw hooks enable <hook-name>

Chi tiết session-memory

Trích xuất 15 tin nhắn người dùng/trợ lý gần nhất và lưu vào <workspace>/memory/YYYY-MM-DD-HHMM.md bằng ngày cục bộ của máy chủ. Việc ghi nhớ chạy trong nền để xác nhận /new và /reset không bị trì hoãn bởi việc đọc transcript hoặc tạo slug tùy chọn. Đặt hooks.internal.entries.session-memory.llmSlug: true để tạo slug tên tệp mô tả bằng mô hình đã cấu hình. Yêu cầu cấu hình workspace.dir.

Cấu hình bootstrap-extra-files

{  "hooks": {    "internal": {      "entries": {        "bootstrap-extra-files": {          "enabled": true,          "paths": ["packages/*/AGENTS.md", "packages/*/TOOLS.md"]        }      }    }  }}

Đường dẫn được phân giải tương đối với workspace. Chỉ các basename bootstrap được nhận diện mới được tải (AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md, BOOTSTRAP.md, MEMORY.md).

Chi tiết command-logger

Ghi nhật ký mọi lệnh slash vào ~/.openclaw/logs/commands.log.

Chi tiết compaction-notifier

Gửi tin nhắn trạng thái ngắn vào cuộc trò chuyện hiện tại khi OpenClaw bắt đầu và hoàn tất việc compact transcript phiên. Điều này giúp các lượt dài bớt khó hiểu trên bề mặt chat vì người dùng có thể thấy trợ lý đang tóm tắt ngữ cảnh và sẽ tiếp tục sau Compaction.

Chi tiết boot-md

Chạy BOOT.md từ workspace đang hoạt động khi gateway khởi động.

Hook của Plugin

Plugin có thể đăng ký hook có kiểu thông qua Plugin SDK để tích hợp sâu hơn: chặn lời gọi công cụ, sửa đổi prompt, kiểm soát luồng tin nhắn, và hơn thế nữa. Dùng hook Plugin khi bạn cần before_tool_call, before_agent_reply, before_install, hoặc các hook vòng đời trong tiến trình khác.

Để xem tham chiếu hook Plugin đầy đủ, xem Hook của Plugin.

Cấu hình

{  "hooks": {    "internal": {      "enabled": true,      "entries": {        "session-memory": { "enabled": true },        "command-logger": { "enabled": false }      }    }  }}

Biến môi trường theo từng hook:

{  "hooks": {    "internal": {      "entries": {        "my-hook": {          "enabled": true,          "env": { "MY_CUSTOM_VAR": "value" }        }      }    }  }}

Thư mục hook bổ sung:

{  "hooks": {    "internal": {      "load": {        "extraDirs": ["/path/to/more/hooks"]      }    }  }}

Tham chiếu CLI

# List all hooks (add --eligible, --verbose, or --json)openclaw hooks list # Show detailed info about a hookopenclaw hooks info <hook-name> # Show eligibility summaryopenclaw hooks check # Enable/disableopenclaw hooks enable <hook-name>openclaw hooks disable <hook-name>

Thực hành tốt nhất

• Giữ handler chạy nhanh. Hook chạy trong quá trình xử lý lệnh. Chạy công việc nặng theo kiểu fire-and-forget bằng void processInBackground(event).
• Xử lý lỗi một cách nhẹ nhàng. Bọc các thao tác rủi ro trong try/catch; không throw để các handler khác vẫn có thể chạy.
• Lọc sự kiện sớm. Trả về ngay nếu loại/hành động sự kiện không liên quan.
• Dùng khóa sự kiện cụ thể. Ưu tiên "events": ["command:new"] thay vì "events": ["command"] để giảm overhead.

Khắc phục sự cố

Không phát hiện được hook

# Verify directory structurels -la ~/.openclaw/hooks/my-hook/# Should show: HOOK.md, handler.ts # List all discovered hooksopenclaw hooks list

Hook không đủ điều kiện

openclaw hooks info my-hook

Kiểm tra các binary bị thiếu (PATH), biến môi trường, giá trị cấu hình hoặc khả năng tương thích hệ điều hành.

Hook không thực thi

1. Xác minh hook đã được bật: openclaw hooks list
2. Khởi động lại tiến trình gateway để hook được tải lại.
3. Kiểm tra nhật ký gateway: ./scripts/clawlog.sh | grep hook

Liên quan

• Tham chiếu CLI: hooks
• Webhook
• Hook Plugin — hook vòng đời plugin trong tiến trình
• Cấu hình