Mailly文档

Webhooks

让来信与投递事件进入你的程序。

在工作台 Webhooks 页面配置公网 HTTPS 端点。收件支持 Workspace 默认端点,每个地址也可以配置多个专属端点;投递 Webhook 可以选择需要的事件。

来信

  • email.received:读取事件中的邮件 ID 与 thread_id,再通过接口获取正文或完整会话。
  • webhook.test:保存端点后可在工作台点「发送测试」,立即收到一条签名的测试事件;结构与 email.received 相同但带 test: true,返回 2xx 即通过。
CLI · incoming webhook
mailly inbox webhook set \
  --url https://your-service.example.com/mailly \
  --body-format markdown \
  --strip-quotes --json

上面的命令会修改 Webhook 配置。请换成你拥有的真实 HTTPS 端点,测试时使用独立地址。

投递事件

投递 Webhook 报告每个收件人的结果,如送达、退信和投诉。“请求成功”不能替代最终送达状态。投递事件可以在工作台查看并重放。

校验请求

  • 每个请求都要验证 Mailly-Signature 签名。
  • 按事件 ID 去重;投递失败的通知会重试。
  • 签名密钥创建或轮换后只显示一次。

本页内容