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 測試台完成驗證並安全地測試。
開啟測試台 →