建立 Webhook 訂閱

建立一筆 Webhook 訂閱，指定接收 URL 與事件類型後，符合條件的事件會主動推送到你的系統。回應中的簽章密鑰僅顯示一次，請妥善保存。

post

Authorizations

X-API-KeystringRequired

Body

建立訂閱的請求 body。

event_typestringRequired

訂閱的事件類型，例如 large_transfer、address_activity。

target_urlstringRequired

事件送達的目標 URL。

Responses

200

建立成功，回傳訂閱資訊與一次性簽章密鑰

application/json

統一成功回應信封。

• data：實際的業務資料（泛型 T，必須可序列化）。
• meta：與這次請求有關的中繼資訊（request id、分頁、credit 用量等）。

400

請求參數有誤，請檢查輸入內容

401

缺少或無效的 API key

post/v1/webhooks

POST /v1/webhooks HTTP/1.1
Host: api.blockchainsecurity.asia
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "event_type": "large_transfer",
  "target_url": "https://example.com/webhook-receiver"
}

{
  "data": {
    "created_at": "2026-07-06T10:11:20.941438Z",
    "event_type": "large_transfer",
    "id": "fce267cb-2902-49f9-8444-2dfecf1e17b9",
    "secret": "whsec_e24bf02555664706b56d7b0948e1fa307c4b34f85f2548e0a08de23c1fe961da",
    "status": "active",
    "target_url": "https://example.com/webhook-receiver"
  },
  "meta": {
    "request_id": "39042bac-1fb2-46cb-96c6-df41e4ede8ee"
  }
}