Webhook

Webhook是一种事件驱动的通信机制，允许应用程序在特定事件发生时，通过HTTP请求自动向另一个应用程序发送通知和数据。

Webhook通过自定义的回调URL实现跨系统通信，当指定事件（如代码更新、数据变化等）触发时，源应用会向预设的Webhook URL发送HTTP POST请求，接收方可通过该URL实时获取事件信息。
Baklib提供Webhook功能，支持知识库设置，站点设置，文章内容变更时推送通知。

1. 配置

在 资源库管理后台，打开 管理 → Webhooks，即可为资源库配置接收地址与事件类型。

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

2. 事件

事件名	说明
`dam.entity.created`	资源创建。
`dam.entity.updated`	资源更新。
`dam.entity.deleted`	资源删除。
`dam.collection.created`	合集创建。
`dam.collection.updated`	合集更新。
`dam.collection.deleted`	合集删除。
`dam.tag.created`	标签创建。
`dam.tag.updated`	标签更新。
`dam.tag.deleted`	标签删除。

3. 示例负载

# 资源（`dam.entity.created`）

```http
POST https://your-app.example.com/webhooks/xx
Content-Type: application/json
X-Baklib-Webhook-Sign: 9d274d2b57f4cb614f1939bd4ee88e5a8e3b4b3f1f06f0ea5de9ef42f7b2d31e
```
```json
{
  "resource_type": "entity",
  "id": 501,
  "iid": 501,
  "name": "品牌规范.pdf",
  "type": "Dam::Entities::File",
  "description": "品牌视觉规范文件",
  "organization_id": 12,
  "created_by_id": 100,
  "created_at": "2026-04-21T09:00:00.000+08:00",
  "updated_at": "2026-04-21T09:00:00.000+08:00",
  "main_version_id": 8801,
  "collection_ids": [77, 78],
  "event_name": "created",
  "hook_time": 1776733200000
}
```

# 合集（`dam.collection.updated`）

```http
POST https://your-app.example.com/webhooks/xx
Content-Type: application/json
X-Baklib-Webhook-Sign: 57b9172f51a4bf84d95fc9b62490d4f50d66fdf342e5ffba7f6b7a92889d464e
```
```json
{
  "resource_type": "collection",
  "id": 77,
  "iid": 77,
  "name": "品牌资产",
  "kind": "default",
  "ancestry": null,
  "organization_id": 12,
  "created_at": "2026-04-01T12:00:00.000+08:00",
  "updated_at": "2026-04-21T09:10:00.000+08:00",
  "event_name": "updated",
  "hook_time": 1776733800000
}
```

# 标签（`dam.tag.deleted`）

```http
POST https://your-app.example.com/webhooks/xx
Content-Type: application/json
X-Baklib-Webhook-Sign: 5f4e2e7b401c95aefab87e0d489bfbc98d4fcf819fb33823b6be4bbf1582a39c
```
```json
{
  "resource_type": "tag",
  "id": 301,
  "iid": 301,
  "name": "活动素材",
  "bg_color": "#F59E0B",
  "scope": "dam",
  "organization_id": 12,
  "ref_id": null,
  "created_at": "2026-03-18T10:00:00.000+08:00",
  "updated_at": "2026-04-21T09:20:00.000+08:00",
  "event_name": "deleted",
  "hook_time": 1776734400000
}
```

提交反馈

搜索