Webhook


Webhook是一种事件驱动的通信机制,允许应用程序在特定事件发生时,通过HTTP请求自动向另一个应用程序发送通知和数据。
Webhook通过自定义的回调URL实现跨系统通信,当指定事件(如代码更新、数据变化等)触发时,源应用会向预设的Webhook URL发送HTTP POST请求,接收方可通过该URL实时获取事件信息。
Baklib提供Webhook功能,支持知识库设置,站点设置,文章内容变更时推送通知。

1. 配置

站点管理后台,打开 设置 → Webhooks,即可为该知识库配置接收地址与事件类型。
  1. 填写从接收方的平台获取 Webhook URL,系统会通过 POST 方式推送事件到这个地址。
  2. 启用后将验证接收方服务器的 SSL 证书。如果接收方使用自签名证书,建议关闭此选项。
  3. 添加 Webhook 添加描述信息,帮助您更好地识别和管理不同的 Webhook。
  4. 填写安全密钥,用于验证 Webhook 请求。
  5. 根据业务需求选择需要接收通知的事件,系统将仅推送您在此处选择的事件类型。
  6. 点击启用,确定即可

2. 事件

事件
说明
kb.articles.created
知识库文章(合集)创建
kb.articles.updated
知识库文章(合集)更新
kb.articles.deleted
知识库文章(合集)删除
kb.article.created
知识库单篇文章创建
kb.article.updated
知识库单篇文章更新
kb.article.deleted
知识库单篇文章删除

3. 示例负载

```http
POST https://your-app.example.com/webhooks/baklib/kb
Content-Type: application/json
X-Baklib-Webhook-Sign: c69b31f42ac3e9b5d2d08da1f9ed8ff85370d54a53aa5f8983b3a89189e2b94b
```
```json
{
  "id": 9001,
  "title": "如何配置 Webhook",
  "body": "<p>这是文章正文示例</p>",
  "created_at": "2026-04-20T16:30:00.000+08:00",
  "updated_at": "2026-04-21T09:30:00.000+08:00",
  "hook_time": 1776735000000,
  "event_name": "kb.article.created"
}
```
提交反馈