跳到正文
FunCoding

搜索

搜索文档、Skill 和 MCP

Webhooks

openclaw webhooks 的 CLI 参考(Gmail Pub/Sub 设置和运行器)

Webhook 辅助工具和集成。目前,此功能仅适用于基于内置 gog 监视器构建的 Gmail Pub/Sub 流程。

子命令

openclaw webhooks gmail setup --account <email> [...]
openclaw webhooks gmail run   [--account <email>] [...]
子命令描述
gmail setup一次性向导:设置 Gmail 监视、Pub/Sub 主题/订阅以及 OpenClaw 钩子投递。
gmail run在前台运行 gog watch serve 和监视自动续期循环。

设置 hooks.enabled=true 和 hooks.gmail.account(由 gmail setup 设置)后,Gateway 网关还会在启动时自动启动 gog gmail watch serve。gmail run 会在前台运行相同逻辑,适用于调试或 Gateway 网关监视器已禁用的情况。有关自动启动的详细信息和 OPENCLAW_SKIP_GMAIL_WATCHER 退出选项,请参阅 Gmail Pub/Sub 集成。

webhooks gmail setup

openclaw webhooks gmail setup --account [email protected]
openclaw webhooks gmail setup --account [email protected] --project my-gcp-project --json
openclaw webhooks gmail setup --account [email protected] --hook-url https://gateway.example.com/hooks/gmail

如果缺失,则安装 gcloud 和 gog;对 gcloud 进行身份验证;创建 Pub/Sub 主题和订阅;启动 Gmail 监视;并写入带有 hooks.enabled=true 的 hooks.gmail 配置。输出 Next: openclaw webhooks gmail run。

必需

标志描述
--account <email>要监视的 Gmail 账号。

Pub/Sub 选项

标志默认值描述
--project <id>(无)GCP 项目 ID(OAuth 客户端所有者)。回退到主题自身的项目 ID,然后回退到从 gog 凭据解析出的项目。
--topic <name>gog-gmail-watchPub/Sub 主题名称。
--subscription <name>gog-gmail-watch-pushPub/Sub 订阅名称。
--label <label>INBOX要监视的 Gmail 标签。
--push-endpoint <url>(无)显式 Pub/Sub 推送端点。覆盖 Tailscale。

OpenClaw 投递选项

标志默认值描述
--hook-url <url>根据 hooks.path 和 Gateway 网关端口构建OpenClaw Webhook URL。
--hook-token <token>hooks.token 或生成的令牌OpenClaw Webhook 令牌。
--push-token <token>生成的令牌转发到 gog watch serve 的推送令牌。

gog watch serve 选项

标志默认值描述
--bind <host>127.0.0.1gog watch serve 绑定主机。
--port <port>8788gog watch serve 端口。
--path <path>/gmail-pubsubgog watch serve 路径。当启用 Tailscale 且未指定显式目标时,强制设为 /,因为 Tailscale 会在代理前移除路径。
--include-bodytrue包含电子邮件正文片段。没有用于关闭此功能的 CLI 标志;请改为在配置中设置 hooks.gmail.includeBody: false。
--max-bytes <n>20000每个正文片段的最大字节数。
--renew-minutes <n>720 (12h)每隔 N 分钟续期 Gmail 监视。

Tailscale 暴露

标志默认值描述
--tailscale <mode>funnel通过 Tailscale 暴露推送端点:funnel、serve 或 off。
--tailscale-path <path>(无)tailscale serve/funnel 的路径。
--tailscale-target <t>(无)Tailscale serve/funnel 目标(端口、host:port 或 URL)。

输出

标志描述
--json输出机器可读的摘要,而非文本。

webhooks gmail run

openclaw webhooks gmail run --account [email protected]

在前台运行 gog watch serve 和监视自动续期循环;如果 gog watch serve 意外退出,则延迟 2s 后重新启动。

run 接受与 setup 相同的 Pub/Sub、OpenClaw 投递、gog watch serve 和 Tailscale 标志,但以下情况除外:

  • --account 在 run 上是可选的;它会回退到 hooks.gmail.account。
  • run 不接受 --project、--push-endpoint 或 --json。
  • 每个标志都会先回退到匹配的 hooks.gmail.* 配置值(由 setup 写入),然后回退到 setup 使用的相同内置默认值,但有一个例外:当标志和 hooks.gmail.tailscale.mode 均未设置时,--tailscale 在 run 上默认为 off(而非 funnel)。
类别标志
Pub/Sub--account、--topic、--subscription、--label
OpenClaw 投递--hook-url、--hook-token、--push-token
gog watch serve--bind、--port、--path、--include-body、--max-bytes、--renew-minutes
Tailscale--tailscale、--tailscale-path、--tailscale-target

对于 run,--topic 值是完整的 Pub/Sub 主题路径(projects/.../topics/...),而不仅是简短主题名称。

相关内容