列出 Webhooks

GET /v1/webhooks

列出已认证用户所有活跃的 Webhook。响应中不会包含签名密钥 -- 仅包含用于识别和管理的元数据。

试一试

在 Swagger UI 中交互式测试此端点。

需要认证

在 Authorization 头中包含您的 API 密钥。

请求

请求头

头	值	必需
Authorization	Bearer <token>	是

此端点不接受查询参数或请求体。

代码示例

curl

curl https://api.docmap.io/v1/webhooks \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch('https://api.docmap.io/v1/webhooks', {
  headers: { 'Authorization': `Bearer ${apiKey}` },
})

const { data } = await response.json()

for (const webhook of data) {
  console.log(`${webhook.url} — events: ${webhook.events.join(', ')}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/webhooks",
    headers={"Authorization": f"Bearer {api_key}"},
)

webhooks = response.json()["data"]

for webhook in webhooks:
    events = ", ".join(webhook["events"])
    print(f"{webhook['url']} — events: {events}")

响应

状态码：200 OK

响应体包含一个 data 数组，由 Webhook 元数据对象组成。

字段

数组中每个对象包含：

字段	类型	描述
id	string	Webhook 的唯一标识符。
userId	string	拥有该 Webhook 的用户 ID。
url	string	注册的端点 URL。
events	string[]	Webhook 订阅的事件。
active	boolean	Webhook 是否处于活跃状态。此响应中始终为 true。
createdAt	string	Webhook 创建时间的 ISO 8601 时间戳。

示例

{
  "data": [
    {
      "id": "webhook-abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://your-app.com/webhooks/docmap",
      "events": ["extraction.completed", "extraction.failed"],
      "active": true,
      "createdAt": "2025-01-15T10:00:00.000Z"
    },
    {
      "id": "webhook-xyz789uvw012",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://slack-webhook.example.com/docmap",
      "events": ["extraction.failed"],
      "active": true,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ]
}

错误

状态码	错误码	描述
401	UNAUTHORIZED	缺少、无效或已过期的 API 密钥/令牌。