新建 WebHooks V2

下面我们来介绍一下应该如何创建一个 WebHook,并使用他。

创建一个 WebHook 只有两个步骤。首先要明确您希望 Coding 项目中的哪些事件被 WebHook 监听,然后,您需要配置一个用来接收和处理事件内容的服务。

设置一个 WebHook

在 Coding 中设置一个项目 WebHook 十分简单,只需要进入项目的『设置』菜单中,选择 『WebHook』功能,然后点击页面右上角的『新建 WebHook』按钮。

点击『新建 WebHook』按钮后会页面会跳转到新建页面。

新建

发送地址 URL

WebHook 会将事件内容发送到这个地址,请填写您用来接收和处理事件内容的服务地址。

我们会在『配置您的服务』章节中介绍如何在本地开发接收事件的服务。在此,我们可以先在『URL』中填入 http://localhost:4567/payload

内容类型

WebHook 发布的内容可以选择不用的类型:

  • 内容为 application/json 类型,发布时会直接装载 JSON 数据到 POST 的 body 中。
  • 内容为 application/x-www-form-urlencoded 类型,发布时会把 JSON 数据作为一个称为 “payload” 的表格参数。 选择最适合您的那个类型,默认的 application/json 内容类型就很合适。

监听事件

事件是 WebHooks 的核心。无论何时,只要项目中进行的操作与事件相关,WebHooks 就会向『URL』发送一个请求,您的服务会立刻接收到事件内容并采取操作。

当所有配置都完成时,点击『新建 WebHook』,WebHook 就创建成功了!现在去配置服务并测试 WebHook 吧,访问『配置您的服务』章节继续我们的学习。