https://github.com/tlikai/hwamei

企业微信webhook，企业微信群机器人webhook，支持Github、Gitlab、Sentry等Webhook
https://github.com/tlikai/hwamei

github gitlab jenkins sentry webhook wxwork

Last synced: 5 days ago
JSON representation

企业微信webhook，企业微信群机器人webhook，支持Github、Gitlab、Sentry等Webhook

• Host: GitHub
• URL: https://github.com/tlikai/hwamei
• Owner: tlikai
• Created: 2018-04-21T15:48:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-01T20:53:59.000Z (over 1 year ago)
• Last Synced: 2024-08-02T18:42:16.707Z (3 months ago)
• Topics: github, gitlab, jenkins, sentry, webhook, wxwork
• Language: JavaScript
• Homepage: https://dinglingdingling.com?utm_source=github_website
• Size: 94.7 KB
• Stars: 200
• Watchers: 15
• Forks: 25
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# hwamei

## 推荐使用 [DinglingDingling](https://dinglingdingling.com/?utm_source=github_hwamei) 替代本项目，无需部署，简单配置即可打通企业微信群机器人与Github、Gitlab、Sentry、Jenkins 等工具 webhook。

hwamei 是一个基于 hubot 的企业微信聊天机器人，它能够通过 webhook 将收集的信息发送到企业微信群中。

已兼容企业微信原生webhook机器人！！！ 具体见 https://github.com/tlikai/hwamei/pull/2

## 预览

![企业微信群聊天机器人](http://p.qpic.cn/pic_wework/439528718/dadcc3d69e2a69710cbb7ce270aab93f77fa86e5d64bf11c/0)

## 工作流程

![工作流程](./data/flow.png)

## 安装

- `git clone https://github.com/tlikai/hwamei.git`

- 运行 `npm install`

- 复制 sample.env 为 .env

- 到企业微信后台创建一个应用

- 将企业微信的 corpId 和 新建应用的 secret 填入 .env 文件

## 使用

- 运行 `./bin/hubot` 即可启动 hwamei

- 目前支持通过命令管理企业微信群、管理 webhook

## 部署

见 https://github.com/hubotio/hubot/blob/master/docs/deploying.md

## 企业微信相关命令

- `hwamei>wxwork create chat {chatid} with {users}` 创建一个群, users 以英文逗号分隔

- `hwamei>wxwork destroy chat {chatid}` 删除一个群

- `hwamei>wxwork show {chatid}` 显示群信息

- `hwamei>wxwork add {userid} to {chatid}` 添加用户到指定群

- `hwamei>wxwork remove {userid} from {chatid}` 从指定群中删除用户

企业微信消息推送文档 https://work.weixin.qq.com/api/doc#90000/90135/90243

## webhook 相关命令

- `hwamei>webhook create {name} from {type} to {chatid}` 创建一个 webhook

- `hwamei>webhook list` 列出所有 webhook

- `hwamei>webhook delete all` 删除所有 webhook

- `hwamei>webhook delete {token}` 删除一个 webhook

- `hwamei>webhook update {token} {name|type|chat_id} to {value}` 修改一个 webhook

- `hwamei>webhook backup` 备份 webhooks 到 ./data/webhooks.json

- `hwamei>webhook restore` 恢复 webhooks

### webhook 使用

1. 先创建 webhook

  - `hwamei>webhook create test_incoming_webhook from incoming to test`

  - 上面命令会创建一个名为 test_incoming_webhook 的 webhook，接收 incoming 类型的输入，输出到 test 企业微信群

  - 运行命令后系统会输出 webhook url，像这个 url 发送请求即可触发 webhook

  - `There is your webhook url: /incoming/408dcc98-60a6-4a10-8c77-4679dd9a0a40`

2. 测试 webhook

  - `shell>curl -XPOST http://localhost:8080/incoming/408dcc98-60a6-4a10-8c77-4679dd9a0a40 -H 'Content-type: application/json' -d '{ "message": "hello hwamei" }'`

  - 运行上面的命令，正常情况下你的企业微信群应该就收到消息了

3. 目前支持下列几种类型的 webhook type

  - incoming 

    - `{ "message": "hello hwamei" }`

    - `{ "text": "hello hwamei" }`

  - sentry

  - gitlab

  - github

## 扩展更多命令

查看 https://github.com/hubotio/hubot/blob/master/docs/scripting.md