跳到主要内容

使用 Webhook 触发运行

Webhook 提供了一种自动将数据从一个应用程序发送到另一个应用程序的方法。使用 webhook,你可以在特定时间或事件发生时触发 Postman 中的 collection run。你还可以将自定义负载发送到 webhook,在 collection run 时可以访问它。这使集合能够独立于任何环境运行,而不是仅依赖于发送到 webhook 的数据。

创建网络钩子

使用收集 webhook,当某些事件被触发时,数据将使用 POST 请求发送到 webhook URL。(由你来配置发送数据的应用程序以及触发事件是什么。)发送到 webhook 的数据可在全局对象的集合内 访问 。使用 脚本 ,你可以解析该数据并在 collection run 期间以任何可能的方式使用它。

集合的 Webhooks 只能使用 Postman API 创建。要创建 Webhook,请参阅 api.getpostman.com/webhooks 的文档

在脚本中访问请求正文

Webhook 的请求正文在globals.previousRequest对象内部可用。要使用它,首先要解析globals.previousRequest对象。data发送到 webhook 的数据在已解析对象内的参数中可用,如该代码片段所示。

var previousRequest = JSON.parse(globals.previousRequest),
webhookRequestData = previousRequest.data;

// webhookRequestData contains the data sent to your webhook.
console.log(JSON.stringify(webhookRequestData));

发送到 webhook 的请求正文必须仅使用 JSON 格式。

将输出发送到另一个 API

发送到收集 webhook 的数据可用于定义逻辑和触发另一个 API。例如,你可以为 GitHub 存储库设置一个 webhook。根据存储库中发生的更新,你可以使用 webhook 运行自定义构建管道或执行 CI 测试。