POST
/api/v1/webhooks创建 Webhook
为作业和文档事件注册带签名的回调目标。
认证
API 密钥
权限范围
webhooks:write
契约
API v1
请求
curl -X POST 'https://api.maxscanner.app/api/v1/webhooks' \
-H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: unique-request-id' \
-d '{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }'请求体
{ "url": "https://example.com/maxscanner/webhook", "events": ["job.completed"] }响应
{ "id": "wh_123", "status": "active" }实现说明
- 仅支持 HTTPS 端点。
- 请验证签名并对事件 ID 去重。
试用此端点
在将端点接入应用之前，先用 API 测试台完成认证并安全地测试。
打开测试台 →