Baklib 文档中心
登录 官网

Webhooks

巴克励步

概述

Webhooks 在站点发生特定事件（如页面发布、更新）时，向配置的 URL 发送 HTTP 请求，便于对接通知系统、CI/CD、自建搜索索引或数据分析流水线。
入口位于应用后台 管理 → Webhooks（路径：/settings/webhooks）。本篇说明如何创建、启用与管理应用级 Webhook。知识库与资源库亦有独立 Webhook 能力，入口不同，勿混淆。

操作步骤

步骤一：进入 Webhooks 列表

  1. 进入目标应用 后台管理。
  2. 在左侧 管理 分组中点击 Webhooks。
18-01-Webhooks列表.png
  1. 阅读页顶说明：请妥善保管回调地址与密钥；生产环境建议开启 SSL 校验并限制来源。
预期结果：看到已配置的 Webhook 列表，或空状态引导「创建第一个 Webhook」。

步骤二：创建 Webhook

  1. 点击 创建第一个 Webhook 或 新增（以界面文案为准）。
18-02-新建Webhook.png
  1. 填写 回调 URL（接收事件的 HTTPS 地址）。
  2. 选择要订阅的 事件类型（如页面发布、更新、删除等，以勾选列表为准）。
  3. 若提供 密钥 / Secret，保存后用于校验请求签名（具体算法见 Baklib API 文档）。
  4. 点击 保存 或 创建。
注意：回调地址勿泄露到公开仓库；测试时可使用内网穿透工具，上线后更换为正式域名。
预期结果：列表中出现新 Webhook，状态为启用或待测试（以界面为准）。

步骤三：测试与维护

  1. 测试投递：若界面提供「测试」或「发送测试事件」，点击后检查接收端是否收到请求。
  2. 查看日志：部分环境可在操作日志或接收端访问日志中核对 HTTP 状态码与响应体。
  3. 启用 / 停用：临时维护接收服务时可关闭 Webhook，避免大量失败重试。
  4. 编辑 / 删除：事件范围变更时更新订阅类型；废弃集成时删除对应条目。
预期结果：目标 URL 在订阅事件发生时收到格式正确的 HTTP 回调。

常见问题

Q：Webhooks 与操作日志有何区别？
A：Webhooks 向外主动推送事件；操作日志（事件统计与操作日志）在后台记录成员操作历史，供人工审计，不替代对外推送。
Q：接收不到回调怎么办？
A：依次检查：URL 是否 HTTPS 可访问、防火墙是否放行、事件类型是否勾选、接收端是否返回 2xx 响应。
Q：知识库 Webhook 在哪里配？
A：知识库级 Webhook 在知识库设置中配置，与应用级入口分离；见第三章相关文档（待编写）。
Q：是否会重复推送？
A：网络超时或接收端非 2xx 时平台可能重试；接收端应实现幂等处理（按事件 ID 去重）。

相关阅读

联系客服
在线咨询