跳到主要内容

Webhooks 概览

Webhooks 允许你在平台上发生事件时接收通知。这些通知会被发送到你指定的 HTTPS 端点。

配置方法

每个实例支持多个 Webhook URL。管理员可通过【设置】→【集成】→【Webhook 订阅】进行配置。每个订阅可以监听实例下所有商户账户的事件,或仅监听某一个商户账户的事件。

旧版 Webhook 订阅迁移

在引入【Webhook 订阅】仪表盘之前,Webhook 配置方式有限:

  • 每个商户账户支持两个 webhook,仅在支付成功和退款成功时进行通知。
  • 实例级别的 webhook,可在创建交易请求时通过 webhooks_url 字段指定通知地址。

这些旧版订阅目前仍然有效。我们计划自动迁移,你也可以手动迁移:

  • 商户级别:虽然该选项已从仪表盘移除,但仍可通过 API 激活。迁移方法:在【设置】→【集成】→【Webhook 订阅】中启用新订阅,然后通过 API 或支持团队取消旧 URL。
  • 实例级别:请联系支持团队协助迁移到新系统。

Webhook 投递行为(旧版 vs 新版)

迁移期间需注意以下行为:

  1. 同时激活的旧版和新版订阅都会收到事件
    只要两者都激活且指向不同 URL,每个都会收到 Webhook。
  2. 同一 URL 不会重复投递
    如果旧版和新版订阅指向同一 URL,系统会去重,只投递一次,避免重复事件。
  3. 重试机制以订阅为单位
    如果 Webhook 投递失败,仅会对失败的订阅进行重试,其他订阅(无论 URL 是否相同)不会受影响。
  4. 迁移完成后旧版订阅将停用
    自动迁移完成后,仅保留新版订阅系统。

支持的功能

  • 每个商户账户支持多个 Webhook 订阅
  • 支持商户账户级和实例级 Webhook 订阅
  • 针对交易、支付方式、买家、账单详情等事件提供详细的 payload
  • 支持基本认证(用户名/密码)
  • 自动重试未成功投递的事件
  • Webhook 签名校验真实性

如需进一步了解 Webhook 的 payload、事件类型和签名校验,请参见后续文档章节。

Powered by Docusaurus