Webhook 是一個 HTTP 請求,當特定事件發生時,服務會將其發送到您註冊的 URL。它讓您的系統能夠即時接收數據,而不是通過不斷調用 API 來檢查是否有新數據可用。在數據管道中,這意味著工作可以在源報告事件的時候立即做出反應。

例如,支付平台 Stripe 會通過 HTTPS 將 webhook 事件作為 JSON 負載發送到您的端點。您的端點必須接受 POST 請求並處理接收到的事件數據。

Webhook 傳遞的工作原理

Stripe 的文檔顯示了主要的機制:

  • 註冊: 您註冊一個端點 URL。在實時模式下,Stripe 需要一個公開可訪問的 HTTPS URL。
  • 快速確認: 端點應該快速返回 2xx 狀態碼,在任何可能導致超時的複雜邏輯之前。
  • 重試: 如果傳遞失敗,Stripe 在實時模式下會以指數回退的方式重試最多三天。
  • 排序: Stripe 不保證事件按創建順序到達。

保護 Webhook 端點

  • 驗證簽名: Stripe 使用 SHA-256 對每個事件進行 HMAC 簽名,並將簽名放在 Stripe-Signature 標頭中。
  • 阻止重放: 簽名的負載包含時間戳,因此您可以拒絕過舊的事件。
  • 處理重複: 一個端點可以接收到相同的事件多次。記錄已處理的事件 ID 並跳過重複。
  • 允許發送者: Stripe 從一個已發布的 IP 地址列表發送 webhook,您可以將防火牆限制為該列表。

常見的 Webhook 用途

  • 代碼和部署: GitHub 將 HTTP POST 負載發送到您訂閱的存儲庫事件的 URL。其文檔列出了如啟動 CI 構建、更新外部問題跟踪器、刷新備份鏡像和部署到生產服務器等用途。
  • 支付: Stripe webhook 讓您能夠響應異步事件,例如銀行確認支付、客戶對收費提出異議或定期支付成功。
  • 僅訂閱您需要的內容: Stripe 建議不要監聽額外或所有事件,因為這會對您的服務器造成不必要的壓力。

相關術語