mirror of
https://github.com/hansjone/oclaw.git
synced 2026-10-09 05:50:44 +08:00
本次迁移将网关/通道/工具/技能/脚本与协议资源集中到新结构,统一路径常量与脚本转发机制,减少顶层噪音并保证运行与测试行为一致。 Made-with: Cursor
1.2 KiB
1.2 KiB
Webhooks 扩展(中文重写)
对应上游目录:vendor/oclaw/extensions/webhooks
能力定位
- 提供“认证后的入站 webhook”,把外部自动化请求绑定到 Oclaw TaskFlow。
- 支持多 route 配置,每个 route 对应 path/session/secret/controller。
关键入口
oclaw.plugin.json:声明插件id=webhooks及配置 schema。index.ts:读取 routes 配置并注册 HTTP 路由。api.ts:导出插件 SDK 类型入口。runtime-api.ts:运行时相关公共接口。
配置核心(来自 schema)
routes.<routeId>.enabled:是否启用。routes.<routeId>.path:Webhook 路径。routes.<routeId>.sessionKey:绑定会话键。routes.<routeId>.secret:密钥(字符串或 secretRef)。routes.<routeId>.controllerId:默认控制器标识。routes.<routeId>.description:可选说明。
secret 支持类型
- 直接字符串密钥。
secretRef对象:source(env/file/exec)+provider+id。
运行关注点
- 路由是否注册成功并与
sessionKey对齐。 - secret 解析是否正确(配置路径与 provider 可用性)。
- 外部系统调用失败时的日志可观测性(routeId/path/sessionKey)。