Skip to content

支持的事件

WebHooker 支持 28 种 GitHub webhook 事件类型,每种都有专用的格式化器,生成丰富的 Discord 嵌入消息与 Telegram HTML 消息——此外还有来自签名自定义 JSON webhook 的 custom 事件。不支持的事件会回退到通用格式化器。

事件表

事件说明嵌入亮点
push代码推送到分支提交列表、分支、作者、差异统计
pull_requestPR 打开/关闭/合并/编辑PR 标题、分支、差异统计、标签
issues议题打开/关闭/编辑议题标题、标签、指派人
issue_comment议题或 PR 的评论评论内容、议题引用
workflow_runCI/CD 工作流阶段更新工作流状态、结论、耗时;各阶段原地更新同一条消息
workflow_jobCI 作业阶段更新作业名、状态、结论、工作流
status提交状态更新提交状态、上下文、状态值、提交链接
deployment部署已创建环境、引用、任务
deployment_status部署状态更新环境、状态、提交引用
check_run检查运行阶段更新状态、结论、详情 URL;各阶段原地更新同一条消息
check_suite检查套件完成套件结论、head 分支、提交链接
pingWebhook 确认Webhook 确认、已订阅的事件类型
release发布创建/编辑标签、内容、附件、预发布标记
create分支或标签已创建引用名称、引用类型
delete分支或标签已删除引用名称、引用类型
star仓库加星/取消星标星标数、操作
fork仓库已复刻源 → 目标复刻
pull_request_reviewPR 审查已提交审查状态(已批准/需修改/已评论)、正文
pull_request_review_comment行内代码审查评论文件路径、行号、评论内容
commit_comment提交的评论提交 SHA、评论内容
member协作者添加/移除成员登录名、操作
label标签创建/编辑/删除标签名称、颜色、描述
milestone里程碑打开/关闭进度条、议题计数、截止日期
discussion讨论创建/回答标题、分类、操作
discussion_comment讨论的评论评论内容、讨论引用
repository仓库重命名/转移旧 → 新名称、变更
code_scanning_alert代码扫描告警严重程度、规则 ID、文件路径
dependabot_alertDependabot 告警严重程度、包、受影响版本、修复版本
custom签名的自定义 JSON webhook任意 title/description/color/url/author/fields(见自定义 webhook

颜色编码

每种事件类型在 Discord 嵌入中使用不同的颜色(来自 server/lib/formatters/colors.ts):

颜色事件
绿色 (#2da44e)push、PR 打开/可审查、issue 打开、工作流成功、发布已发布、检查成功、审查已批准、部署成功、成员添加、里程碑关闭、讨论已回答
红色 (#f85149)PR 关闭、issue 关闭、工作流失败、发布已删除、delete、检查失败、审查请求修改、部署失败、成员移除、代码扫描/Dependabot 严重与高危
紫色 (#8957e5)PR 合并、label、discussion
蓝色 (#1f6feb)PR(其他操作)、issue 重新打开、fork、里程碑打开
黄色 (#d29922)工作流(排队/运行中/其他)、预发布 release、star、检查(其他)、部署待定、代码扫描/Dependabot 中危
灰色 (#6e7681)issue 评论、commit 评论、讨论评论
灰色 (#8b949e)审查评论、repository、代码扫描/Dependabot 低危、默认

通用回退

没有专用格式化器的事件类型会回退到通用格式化器,生成包含以下内容的基础嵌入:

  • 事件类型作为标题(可用时附带操作)
  • 发送者登录名(作者行)
  • 仓库名称(页脚)

原地消息更新

workflow_run / check_run 事件(queued → running → success/failure)只发送一条消息,后续每个阶段会原地编辑该消息,而不是发送新消息。消息的链接预览、作者和字段布局保持不变,仅刷新状态、结论 emoji、耗时和标题。Discord(editMessage)和 Telegram(editMessageText / editMessageCaption)均支持。

过滤器兼容性

实操指南见过滤器教程,包含完整示例。

过滤器适用事件
event所有事件
repo所有事件
actor所有事件
action载荷中包含 action 字段的事件
branchpush、pull_request、pull_request_review、pull_request_review_comment、create、delete、workflow_run、workflow_job、check_suite、deployment、code_scanning_alert
keyword所有事件(搜索完整载荷正文)

基于 MIT 许可发布。