如何在Postman集合中检查Webhook调用

前置准备 #

• 提前整理好你要发送的Webhook触发Payload，确认参数结构、字段类型符合业务要求
• 确认你要验证的Webhook接收地址，或直接使用Postman内置的请求捕获服务作为临时接收端

步骤1：配置触发用的POST请求 #

• 在你的Postman集合中新建一个POST请求，URL填入Webhook的触发地址
• 切换到「Body」标签页，选择raw格式，下拉菜单选JSON（或你需要的Payload格式），在文本框中填入你准备好的Payload内容，示例参考：

{
  "event": "order_created",
  "order_id": "123456",
  "amount": 99.9,
  "timestamp": 1699999999
}

• 如果有鉴权要求，切换到「Authorization」标签页配置对应的鉴权规则，比如API Key、Bearer Token等

步骤2：配置Webhook调用结果检查逻辑 #

方案A：Webhook接收端有回调地址可直接访问 #

• 发送完触发用的POST请求后，在Postman集合中新增一个GET请求，填入Webhook接收端的查询接口地址
• 切换到「Tests」标签页，编写断言脚本校验Webhook是否成功触发、Payload参数是否匹配，示例断言：

// 校验接口返回状态码
pm.response.to.have.status(200);
// 校验返回的Webhook记录中Payload和你发送的一致
const res = pm.response.json();
pm.expect(res.payload.order_id).to.eql("123456");
pm.expect(res.payload.event).to.eql("order_created");

方案B：无公开接收地址，使用Postman内置捕获服务 #

• 打开Postman左侧菜单栏的「Mock Servers」，新建一个Mock服务，设置请求路径、返回规则后，将生成的Mock URL作为Webhook的接收地址填入你的触发配置中
• 发送触发POST请求后，点击Mock服务的「Calls」标签，即可直接看到所有发送到该地址的Webhook请求，可直接查看请求头、Body和你发送的Payload是否匹配
• 也可以在Tests脚本中调用Postman Mock服务的查询接口，自动化校验Webhook调用记录

步骤3：集成到集合自动化执行 #

• 将触发POST请求、Webhook结果查询请求按顺序加入你的Postman集合
• 点击集合右上角的「Run」按钮，即可批量执行，自动完成Webhook触发到结果校验的全流程

注意事项 #

• 如果Webhook有延迟推送的情况，可在触发请求的Tests脚本中添加setTimeout()延迟执行后续的查询请求，避免校验时Webhook还没推送完成
• Payload如果是非JSON格式，比如form-data、x-www-form-urlencoded，要对应调整Body的配置选项和校验脚本的参数解析逻辑

内容的提问来源于stack exchange，提问作者mani kandan