跳到主要内容

WebHook 对企业微信的支持

企业微信在内部群聊中提供了「群机器人」功能。通过 WebHook,可以在企业微信中添加自定义的机器人实现自动通知。

添加机器人

在企业微信群聊中,通过聊天窗口在内部群右键菜单选择 添加群机器人->新创建一个机器人,为机器人设置一个头像和名称,点击「添加」后可以获得一个 WebHook 地址,关闭窗口即可完成企业微信内部群微信机器人的添加。

目前包含外部联系人的群聊不支持添加机器人。

设置机器人 WebHook

在上文的添加过程中,可以获得一个形如 https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 的 WebHook 请求地址,将这个地址添加到 Gitee 上,即可完成对 WebHook 的设置。

在 Gitee 仓库页面,通过「管理」->「WebHooks 设置」->「添加」,可以添加一个新的 WebHook。

将上文得到的 WebHook 的地址填写到 URL 中,选择具体的触发事件,激活并添加即可完成对 WebHook 的设置。

IP 白名单

通过设置请求 IP 地址(段), 可以限制触发机器人的请求 IP 白名单。由于 Gitee 服务请求所在的 IP 段不是固定的,为避免无法正常触发机器人,不建议设置 IP 地址(段)白名单。

触发 WebHooks

通过设置机器人,以下场景会触发 WebHook 请求到企业微信。

  • Push: 仓库推送代码,推送分支,删除分支
  • Tag push: 新建 tag,删除 tag
  • Issue:新建、关闭、重新打开、删除任务 或 修改任务指派人
  • Pull request : 新建 pull request、更新 pull request、合并 pull request
  • 评论:评论仓库、issue(任务)、pull request、commit

相关阅读