跳到主要内容

Webhook 配置

功能概述​

系统支持用户配置 Webhook 回调地址，用于实时接收邮件生命周期中的关键事件状态，帮助用户完成投递监控、用户行为分析与风控处理。

特性说明​

  • 异步推送：Webhook 事件采用异步推送，不影响主投递链路
  • 事件订阅：事件类型可配置订阅，避免无效推送
  • 事件关联：同一邮件可能产生多个事件，需通过 MsgId 进行关联
  • 统计误差：open / click 事件存在一定的统计误差

支持的邮件事件类型​

系统支持以下邮件事件类型：

  • 发送事件：邮件发送成功或失败
  • 投递事件：邮件投递状态更新
  • 打开事件：收件人打开邮件
  • 点击事件：收件人点击邮件中的链接
  • 退信事件：邮件被退回
  • 投诉事件：收件人投诉邮件

注意：具体的事件类型和字段说明，请参考 Webhook API 文档。

配置 Webhook​

设置步骤​

  1. 访问 控制台 Webhook 设置页面
  2. 开启推送功能
  3. 配置推送地址（最多可配置 3 个）：
    • 1 个主地址
    • 2 个备用地址
  4. 保存配置

推送机制​

  • 如果主地址接收异常，系统会依次尝试备用地址
  • 每个地址最多重试 3 次
  • 如果所有地址都失败，系统会记录失败日志

关闭推送​

如果您不需要推送，可以在控制台关闭推送功能。

测试 Webhook​

配置完成后，您可以点击"模拟发送测试"按钮，系统会推送一条模拟的回执，帮助您调试和验证配置。

测试返回示例​

测试返回的 Webhook 数据包含以下信息：

  • 事件类型：模拟事件类型
  • 时间戳：事件发生时间
  • 邮件信息：邮件 ID、主题等基本信息
  • 状态信息：事件状态详情

提示：测试返回的数据格式与实际推送的数据格式一致，可用于验证您的接收接口是否正确处理。