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 地址列表中发送 webhooks,您可以将防火墙限制为这些地址。

常见的 Webhook 用途

  • 代码和部署: GitHub 会向您订阅的存储库事件的 URL 发送 HTTP POST 负载。其文档列出了诸如启动 CI 构建、更新外部问题跟踪器、刷新备份镜像和部署到生产服务器等用途。
  • 支付: Stripe webhooks 让您能够响应异步事件,例如银行确认支付、客户争议收费或定期支付成功。
  • 仅订阅您需要的内容: Stripe 建议不要监听额外或所有事件,因为这会给您的服务器带来不必要的压力。

相关术语