Triggers

GitHub 触发器

通过 GitHub 事件（如 push、pull request、issue 等）触发工作流

通过 GitHub 事件（如 push、pull request、issue 等）触发工作流

这是基于 Webhook 的触发器。请将外部服务配置为向工作流 Webhook URL 发送事件。

用作工具

查看 GitHub 的工作流操作、运算和工具输入。

事件

GitHub Webhook

通过 GitHub 事件（如 push、pull request、issue 等）触发工作流

设置说明

1. 前往 GitHub 仓库 > 设置 > Webhooks。
2. 点击“添加 webhook”。
3. 将上方的 Webhook URL 粘贴到“有效负载 URL”字段。
4. 在下拉菜单中选择对应的内容类型。
5. 如果已配置 Webhook 密钥，请将其填入“密钥”字段。
6. 按照你的选择设置 SSL 验证。
7. 选择应触发此 webhook 的事件。
8. 确认已勾选“激活”，然后点击“添加 webhook”。
内容类型*
application/json
GitHub 发送 Webhook 负载时使用的格式。
Webhook 密钥
••••••••
用于验证 Webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 Webhook 时会验证 SSL 证书。

输出架构

事件载荷
refstringGit 引用（例如 refs/heads/fix/telegram-wh）
beforestring推送前提交的 SHA
afterstring推送后提交的 SHA
createdboolean此次推送是否创建了该引用
deletedboolean此次推送是否删除了该引用
forcedboolean此次推送是否为强制推送
base_refstring此次推送的基础引用
comparestring用于对比变更的 URL
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
forkboolean仓库是否为 fork
urlstring仓库 API URL
created_atnumber仓库创建时间戳
updated_atstring仓库上次更新时间
pushed_atnumber仓库上次推送时间戳
git_urlstring仓库 git URL
ssh_urlstring仓库 SSH URL
clone_urlstring仓库克隆 URL
homepagestring仓库主页 URL
sizenumber仓库大小
stargazers_countnumber星标数量
watchers_countnumber关注者数量
languagestring主要编程语言
forks_countnumberFork 数量
archivedboolean仓库是否已归档
disabledboolean仓库是否已禁用
open_issues_countnumber未关闭 Issue 数量
topicsarray仓库主题
visibilitystring仓库可见性（public、private）
forksnumberFork 数量
open_issuesnumber未关闭 Issue 数量
watchersnumber关注者数量
default_branchstring默认分支名称
stargazersnumber星标数量
master_branchstring主分支名称
ownerobject
licenseobject仓库许可证信息
pusherobject推送者信息
namestring推送者名称
emailstring推送者邮箱
senderobject
loginstring发送者用户名
idnumber发送者 ID
node_idstring发送者节点 ID
avatar_urlstring发送者头像 URL
gravatar_idstring发送者 Gravatar ID
urlstring发送者 API URL
html_urlstring发送者主页 URL
user_view_typestring用户视图类型
site_adminboolean发送者是否为站点管理员
commitsarray提交对象数组
idstring提交 SHA
tree_idstring树 SHA
distinctboolean该提交是否为独立提交
messagestring提交说明
timestampstring提交时间戳
urlstring提交 URL
authorobject提交作者
committerobject提交者
addedarray新增文件数组
removedarray删除文件数组
modifiedarray修改文件数组
head_commitobjectHEAD 提交对象
idstring提交 SHA
tree_idstring树 SHA
distinctboolean该提交是否为独立提交
messagestring提交说明
timestampstring提交时间戳
urlstring提交 URL
authorobject提交作者
committerobject提交者
addedarray新增文件数组
removedarray删除文件数组
modifiedarray修改文件数组
event_typestringGitHub 事件类型（例如 push、pull_request、issues）
actionstring已执行的操作（例如 opened、closed、synchronize）
branchstring从 ref 提取的分支名称

GitHub 议题已打开

当 GitHub 仓库中打开新议题时触发工作流

设置说明

1. 前往 GitHub 仓库 > 设置 > Webhooks。
2. 点击“添加 webhook”。
3. 将上方的 Webhook URL 粘贴到“有效负载 URL”字段。
4. 从下拉菜单中选择所需的内容类型。
5. 如果已配置 Webhook 密钥，请将其填入“密钥”字段。
6. 根据你的选择设置 SSL 验证。
7. 选择“让我选择单个事件”，并勾选 issues（opened 操作）。
8. 确保勾选“处于活动状态”，然后点击“添加 webhook”。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
用于验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 投递 webhook 时会验证 SSL 证书。

输出架构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 issues、pull_request、push）
actionstring执行的操作（opened、closed、reopened、edited 等）
issueobject
idnumber议题 ID
node_idstring议题 node ID
numbernumber议题编号
titlestring议题标题
bodystring议题正文/描述
statestring议题状态（open、closed）
state_reasonstring状态原因（completed、not_planned、reopened）
html_urlstring议题 HTML URL
userobject
labelsarray标签对象数组
assigneesarray被指派用户数组
milestoneobject已分配时的里程碑对象
created_atstring议题创建时间戳
updated_atstring议题最近更新时间戳
closed_atstring议题关闭时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为复刻
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumber星标数量
watchers_countnumber关注者数量
languagestring主要编程语言
forks_countnumber复刻数量
open_issues_countnumber未关闭议题数量
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub Issue 已关闭

当 GitHub 仓库中的 Issue 关闭时触发工作流

设置说明

1. 前往 GitHub 仓库 > Settings > Webhooks。
2. 点击“Add webhook”。
3. 将上方的 Webhook URL 粘贴到“Payload URL”字段。
4. 从下拉菜单中选择内容类型。
5. 如果已配置 Webhook Secret，将其填入“Secret”字段。
6. 根据你的选择设置 SSL 验证。
7. 选择“Let me select individual events”，并勾选 issues（closed 操作）。
8. 确保已勾选“Active”，然后点击“Add webhook”。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 投递 webhook 时会验证 SSL 证书。

输出结构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 issues、pull_request、push）
actionstring执行的操作（opened、closed、reopened、edited 等）
issueobject
idnumberIssue ID
node_idstringIssue 节点 ID
numbernumberIssue 编号
titlestringIssue 标题
bodystringIssue 正文/描述
statestringIssue 状态（open、closed）
state_reasonstring状态原因（completed、not_planned、reopened）
html_urlstringIssue HTML URL
userobject
labelsarray标签对象数组
assigneesarray被指派用户数组
milestoneobject已分配时的里程碑对象
created_atstringIssue 创建时间戳
updated_atstringIssue 最后更新时间戳
closed_atstringIssue 关闭时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumberStar 数量
watchers_countnumberWatch 数量
languagestring主要编程语言
forks_countnumberFork 数量
open_issues_countnumber未关闭 Issue 数量
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户节点 ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub Issue 评论

在议题添加评论时触发工作流（不包括拉取请求）

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击 "Add webhook"。
3. 将上方的 Webhook URL 粘贴到 "Payload URL" 字段。
4. 在下拉菜单中选择所需的内容类型。
5. 若已配置 Webhook Secret，将其填入 "Secret" 字段。
6. 按你的选择设置 SSL 验证。
7. 选择 "Let me select individual events"，并勾选 issue_comment（created、edited、deleted 操作）。
8. 确保勾选 "Active"，然后点击 "Add webhook"。
9. 注意： 此触发器仅筛选议题评论。如需 PR 评论，请使用 "GitHub PR Comment" 触发器。
内容类型*
application/json
GitHub 发送 webhook 载荷时使用的格式。
Webhook Secret
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
已启用
GitHub 投递 webhook 时会验证 SSL 证书。

输出结构

事件载荷
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 issue_comment）
actionstring执行的操作（created、edited、deleted）
issueobject
numbernumber议题编号
titlestring议题标题
statestring议题状态（open、closed）
html_urlstring议题 HTML URL
userobject
commentobject
idnumber评论 ID
node_idstring评论 node ID
bodystring评论文本
html_urlstring评论 HTML URL
userobject
created_atstring评论创建时间戳
updated_atstring评论最后更新时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumber星标数
watchers_countnumber关注者数量
languagestring主要编程语言
forks_countnumberFork 数量
open_issues_countnumber未关闭议题数量
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub PR 已打开

在 GitHub 仓库中打开新的拉取请求时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > 设置 > Webhooks。
2. 点击「添加 webhook」。
3. 将上方的 Webhook URL 粘贴到「有效负载 URL」字段。
4. 在下拉菜单中选择你指定的内容类型。
5. 如果你已配置 Webhook 密钥，请将其填入「密钥」字段。
6. 根据你的选择设置 SSL 验证。
7. 选择「让我选择单个事件」，并勾选 pull_request（opened 操作）。
8. 确保勾选「激活」，然后点击「添加 webhook」。
内容类型*
application/json
GitHub 发送 webhook 载荷时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出结构

事件载荷
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 pull_request）
actionstring执行的操作（opened、closed、synchronize、reopened、edited 等）
numbernumber拉取请求编号
pull_requestobject
idnumber拉取请求 ID
node_idstring拉取请求 node ID
numbernumber拉取请求编号
titlestring拉取请求标题
bodystring拉取请求描述
statestring拉取请求状态（open、closed）
mergedboolean拉取请求是否已合并
merged_atstring拉取请求合并时间戳
merged_byobject
draftboolean是否为草稿拉取请求
html_urlstring拉取请求 HTML URL
diff_urlstring拉取请求 diff URL
patch_urlstring拉取请求 patch URL
userobject
headobject
baseobject
additionsnumber新增行数
deletionsnumber删除行数
changed_filesnumber变更文件数
labelsarray标签对象数组
assigneesarray被指派用户数组
requested_reviewersarray请求的审查者数组
created_atstring拉取请求创建时间戳
updated_atstring拉取请求最后更新时间戳
closed_atstring拉取请求关闭时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumber星标数
watchers_countnumber关注数
languagestring主要编程语言
forks_countnumberFork 数
open_issues_countnumber未关闭 issue 数
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub PR 关闭

当 GitHub 仓库中的拉取请求被关闭且未合并（例如被放弃）时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击 "Add webhook"。
3. 将上方的 Webhook URL 粘贴到 "Payload URL" 字段。
4. 从下拉菜单中选择内容类型。
5. 如果已配置，将 Webhook 密钥 填入 "Secret" 字段。
6. 根据你的选择设置 SSL 验证。
7. 选择 "Let me select individual events" 并勾选 pull_request（closed 操作）。
8. 确保已勾选 "Active"，然后点击 "Add webhook"。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
验证 webhook 请求来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出结构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 pull_request）
actionstring执行的操作（opened、closed、synchronize、reopened、edited 等）
numbernumber拉取请求编号
pull_requestobject
idnumber拉取请求 ID
node_idstring拉取请求节点 ID
numbernumber拉取请求编号
titlestring拉取请求标题
bodystring拉取请求描述
statestring拉取请求状态（open、closed）
mergedbooleanPR 是否已合并
merged_atstringPR 合并时间戳
merged_byobject
draftbooleanPR 是否为草稿
html_urlstring拉取请求 HTML URL
diff_urlstring拉取请求 diff URL
patch_urlstring拉取请求 patch URL
userobject
headobject
baseobject
additionsnumber新增行数
deletionsnumber删除行数
changed_filesnumber变更文件数
labelsarray标签对象数组
assigneesarray被指派用户数组
requested_reviewersarray请求的审查者数组
created_atstring拉取请求创建时间戳
updated_atstring拉取请求最近更新时间戳
closed_atstring拉取请求关闭时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumber星标数
watchers_countnumber关注者数
languagestring主要编程语言
forks_countnumberfork 数
open_issues_countnumber未关闭 issue 数
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户节点 ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub PR 已合并

当 GitHub 仓库中的拉取请求成功合并时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击“Add webhook”。
3. 将上方的 Webhook URL 粘贴到“Payload URL”字段。
4. 从下拉菜单中选择所需的内容类型。
5. 如果已配置，将 Webhook 密钥 填入“Secret”字段。
6. 根据你的选择设置 SSL 验证。
7. 选择“Let me select individual events”并勾选 pull_request。注意：已合并的 PR 的 action='closed' 且 merged=true。
8. 确保已勾选“Active”，然后点击“Add webhook”。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 投递 webhook 时会验证 SSL 证书。

输出架构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 pull_request）
actionstring执行的操作（opened、closed、synchronize、reopened、edited 等）
numbernumber拉取请求编号
pull_requestobject
idnumber拉取请求 ID
node_idstring拉取请求 node ID
numbernumber拉取请求编号
titlestring拉取请求标题
bodystring拉取请求描述
statestring拉取请求状态（open、closed）
mergedbooleanPR 是否已合并
merged_atstringPR 合并时间戳
merged_byobject
draftbooleanPR 是否为草稿
html_urlstring拉取请求 HTML URL
diff_urlstring拉取请求 diff URL
patch_urlstring拉取请求 patch URL
userobject
headobject
baseobject
additionsnumber新增行数
deletionsnumber删除行数
changed_filesnumber变更文件数
labelsarray标签对象数组
assigneesarray被指派用户数组
requested_reviewersarray请求的审查者数组
created_atstring拉取请求创建时间戳
updated_atstring拉取请求上次更新时间戳
closed_atstring拉取请求关闭时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumberStar 数量
watchers_countnumberWatcher 数量
languagestring主要编程语言
forks_countnumberFork 数量
open_issues_countnumber未关闭 issue 数量
default_branchstring默认分支名称
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub PR 评论

当 GitHub 仓库的拉取请求新增评论时触发工作流

设置说明

1. 打开 GitHub 仓库，进入 Settings > Webhooks。
2. 点击“Add webhook”。
3. 将上方的 Webhook URL 粘贴到“Payload URL”字段。
4. 在下拉菜单中选择你设定的 Content Type。
5. 如果已配置 Webhook Secret，将其填入“Secret”字段。
6. 按你的选择设置 SSL 验证。
7. 选择“Let me select individual events”，并勾选 Issue comments。
8. 确认已勾选“Active”，然后点击“Add webhook”。
9. 注意：拉取请求评论使用 issue_comment 事件。可通过检查 issue.pull_request 是否存在来筛选 PR 评论。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
用于验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出结构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 issue_comment）
actionstring执行的操作（created、edited、deleted）
issueobject
idnumberIssue ID
node_idstringIssue 节点 ID
numbernumberIssue/PR 编号
titlestringIssue/PR 标题
bodystringIssue/PR 描述
statestringIssue/PR 状态（open、closed）
html_urlstringIssue/PR HTML URL
userobject
labelsarray标签对象数组
assigneesarray指派人数组
pull_requestobject
created_atstringIssue/PR 创建时间戳
updated_atstringIssue/PR 最后更新时间戳
commentobject
idnumber评论 ID
node_idstring评论节点 ID
urlstring评论 API URL
html_urlstring评论 HTML URL
bodystring评论文本
userobject
created_atstring评论创建时间戳
updated_atstring评论最后更新时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户节点 ID
avatar_urlstring头像 URL
html_urlstring个人主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub PR 审查

当 GitHub 仓库中的拉取请求审查被提交、编辑或驳回时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击 "Add webhook"。
3. 将上方的 Webhook URL 粘贴到 "Payload URL" 字段。
4. 从下拉菜单中选择你指定的内容类型。
5. 如果你已配置 Webhook 密钥，请将其填入 "Secret" 字段。
6. 根据你的选择设置 SSL 验证。
7. 选择 "Let me select individual events"，并勾选 Pull request reviews。
8. 确保已勾选 "Active"，然后点击 "Add webhook"。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出架构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 pull_request_review）
actionstring执行的操作（submitted、edited、dismissed）
reviewobject
idnumber审查 ID
node_idstring审查节点 ID
userobject
bodystring审查评论文本
statestring审查状态（approved、changes_requested、commented、dismissed）
html_urlstring审查 HTML URL
submitted_atstring审查提交时间戳
commit_idstring被审查的提交 SHA
author_associationstring作者关联（OWNER、MEMBER、COLLABORATOR、CONTRIBUTOR 等）
pull_requestobject
idnumber拉取请求 ID
node_idstring拉取请求节点 ID
numbernumber拉取请求编号
titlestring拉取请求标题
bodystring拉取请求描述
statestring拉取请求状态（open、closed）
mergedboolean该 PR 是否已合并
draftboolean该 PR 是否为草稿
html_urlstring拉取请求 HTML URL
diff_urlstring拉取请求 diff URL
patch_urlstring拉取请求 patch URL
userobject
headobject
baseobject
created_atstring拉取请求创建时间戳
updated_atstring拉取请求最后更新时间戳
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户节点 ID
avatar_urlstring头像 URL
html_urlstring主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub 推送

代码推送到仓库时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击 "Add webhook"。
3. 将上方的 Webhook URL 粘贴到 "Payload URL" 字段。
4. 在下拉菜单中选择所需的内容类型。
5. 如果已配置 Webhook 密钥，将其填入 "Secret" 字段。
6. 根据你的选择设置 SSL 验证。
7. 选择 "Let me select individual events" 并勾选 Pushes。
8. 确保已勾选 "Active"，然后点击 "Add webhook"。
内容类型*
application/json
GitHub 发送 webhook 负载时使用的格式。
Webhook 密钥
••••••••
用于验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 投递 webhook 时会验证 SSL 证书。

输出架构

事件负载
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 push）
branchstring从 ref 解析出的分支名（例如从 refs/heads/main 得到 main）
refstring被推送的 Git 引用（例如 refs/heads/main）
beforestring推送前的提交 SHA
afterstring推送后的提交 SHA
createdboolean此次推送是否创建了新分支或标签
deletedboolean此次推送是否删除了分支或标签
forcedboolean此次是否为强制推送
base_refstring此次推送的基准引用
comparestring用于比较变更的 URL
commitsarray此次推送包含的提交对象数组
idstring提交 SHA
tree_idstringGit tree SHA
distinctboolean此提交是否与此次推送中的其他提交不同
messagestring提交说明
timestampstring提交时间戳
urlstring提交 URL
authorobject
committerobject
addedarray此提交中新增的文件路径数组
removedarray此提交中删除的文件路径数组
modifiedarray此提交中修改的文件路径数组
head_commitobject
idstring最近一次提交的 SHA
tree_idstringGit tree SHA
distinctboolean此提交是否为独立提交
messagestring提交说明
timestampstring提交时间戳
urlstring提交 URL
authorobject
committerobject
addedarray此提交中新增的文件路径数组
removedarray此提交中删除的文件路径数组
modifiedarray此提交中修改的文件路径数组
pusherobject
namestring推送者姓名
emailstring推送者邮箱
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumber星标数
watchers_countnumber关注者数量
languagestring主要编程语言
forks_countnumberFork 数
open_issues_countnumber未关闭的 issue 数
default_branchstring默认分支名
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
html_urlstring主页 URL
user_typestring用户类型（User、Bot、Organization）

GitHub 发行版已发布

在 GitHub 仓库发布新发行版时触发工作流

设置说明

1. 前往你的 GitHub 仓库 > Settings > Webhooks。
2. 点击 “Add webhook”。
3. 将上方的 Webhook URL 粘贴到 “Payload URL” 字段。
4. 从下拉菜单中选择你选定的 Content Type。
5. 若已配置 Webhook Secret，请将其填入 “Secret” 字段。
6. 根据你的选择设置 SSL 验证。
7. 选择 “Let me select individual events”，并勾选 Releases 事件。
8. 确保已勾选 “Active”，然后点击 “Add webhook”。
内容类型*
application/json
GitHub 发送 webhook 载荷时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出结构

事件载荷
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 release）
actionstring执行的操作（published、unpublished、created、edited、deleted、prereleased、released）
releaseobject
idnumber发行版 ID
node_idstring发行版 node ID
tag_namestring发行版对应的 Git 标签名
target_commitishstring目标分支或提交 SHA
namestring发行版名称/标题
bodystringMarkdown 格式的发行版说明
draftboolean该发行版是否为草稿
prereleaseboolean该发行版是否为预发布
created_atstring发行版创建时间戳
published_atstring发行版发布时间戳
urlstring发行版 API URL
html_urlstring发行版 HTML URL
assets_urlstring发行版资源 API URL
upload_urlstring用于上传发行版资源的 URL
tarball_urlstring源代码 tarball 下载 URL
zipball_urlstring源代码 zipball 下载 URL
discussion_urlstring讨论 URL（如有）
authorobject
assetsarray包含下载 URL 的发行版资源对象数组
repositoryobject
idnumber仓库 ID
node_idstring仓库 node ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
forkboolean仓库是否为 fork
urlstring仓库 API URL
archive_urlstring归档 API URL
assignees_urlstring指派人 API URL
blobs_urlstringBlob API URL
branches_urlstring分支 API URL
collaborators_urlstring协作者 API URL
comments_urlstring评论 API URL
commits_urlstring提交 API URL
compare_urlstring比较 API URL
contents_urlstring内容 API URL
contributors_urlstring贡献者 API URL
deployments_urlstring部署 API URL
downloads_urlstring下载 API URL
events_urlstring事件 API URL
forks_urlstringFork API URL
git_commits_urlstringGit 提交 API URL
git_refs_urlstringGit refs API URL
git_tags_urlstringGit 标签 API URL
hooks_urlstringHooks API URL
issue_comment_urlstringIssue 评论 API URL
issue_events_urlstringIssue 事件 API URL
issues_urlstringIssues API URL
keys_urlstring密钥 API URL
labels_urlstring标签 API URL
languages_urlstring语言 API URL
merges_urlstring合并 API URL
milestones_urlstring里程碑 API URL
notifications_urlstring通知 API URL
pulls_urlstring拉取请求 API URL
releases_urlstring发行版 API URL
stargazers_urlstringStargazers API URL
statuses_urlstring状态 API URL
subscribers_urlstring订阅者 API URL
subscription_urlstring订阅 API URL
tags_urlstring标签 API URL
teams_urlstring团队 API URL
trees_urlstringTrees API URL
homepagestring仓库主页 URL
sizenumber仓库大小（KB）
stargazers_countnumberStar 数量
watchers_countnumberWatcher 数量
languagestring主要编程语言
has_issuesboolean是否启用 Issues
has_projectsboolean是否启用 Projects
has_downloadsboolean是否启用 Downloads
has_wikiboolean是否启用 Wiki
has_pagesboolean是否启用 GitHub Pages
forks_countnumberFork 数量
mirror_urlstring镜像 URL（若仓库为镜像）
archivedboolean仓库是否已归档
disabledboolean仓库是否已禁用
open_issues_countnumber未关闭 Issue 数量
licenseobject
allow_forkingboolean是否允许 fork
is_templateboolean仓库是否为模板
topicsarray仓库主题数组
visibilitystring仓库可见性（public、private、internal）
forksnumberFork 数量
open_issuesnumber未关闭 Issue 数量
watchersnumberWatcher 数量
default_branchstring默认分支名称
created_atstring仓库创建时间戳
updated_atstring仓库最近更新时间戳
pushed_atstring仓库最近推送时间戳
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户 node ID
avatar_urlstring头像 URL
gravatar_idstringGravatar ID
urlstring用户 API URL
html_urlstring个人主页 URL
followers_urlstring关注者 API URL
following_urlstring正在关注 API URL
gists_urlstringGists API URL
starred_urlstring已加星标仓库 API URL
subscriptions_urlstring订阅 API URL
organizations_urlstring组织 API URL
repos_urlstring仓库 API URL
events_urlstring事件 API URL
received_events_urlstring已接收事件 API URL
user_typestring用户类型（User、Bot、Organization）
site_adminboolean该用户是否为站点管理员

GitHub Actions 工作流运行

当 GitHub Actions 工作流运行被请求、进行中或已完成时触发工作流

设置说明

1. 前往 GitHub 仓库 > Settings > Webhooks。
2. 点击“Add webhook”。
3. 将上方的 Webhook URL 粘贴到“Payload URL”字段。
4. 从下拉菜单中选择所需的内容类型。
5. 若已配置，将 Webhook Secret 填入“Secret”字段。
6. 根据你的选择设置 SSL 验证。
7. 选择“Let me select individual events”，并勾选 Workflow runs。
8. 确保已勾选“Active”，然后点击“Add webhook”。
内容类型*
application/json
GitHub 发送 webhook 载荷时使用的格式。
Webhook 密钥
••••••••
验证 webhook 投递来自 GitHub。
SSL 验证*
启用
GitHub 在投递 webhook 时会验证 SSL 证书。

输出架构

事件载荷
event_typestring来自 X-GitHub-Event 请求头的 GitHub 事件类型（例如 workflow_run）
actionstring执行的操作（requested、in_progress、completed）
workflow_runobject
idnumber工作流运行 ID
node_idstring工作流运行节点 ID
namestring工作流名称
workflow_idnumber工作流 ID
run_numbernumber此工作流的运行编号
run_attemptnumber此运行的尝试次数
eventstring触发该工作流的事件（push、pull_request 等）
statusstring当前状态（queued、in_progress、completed）
conclusionstring结论（success、failure、cancelled、skipped、timed_out、action_required）
head_branchstring分支名称
head_shastring触发该工作流的提交 SHA
pathstring工作流文件路径
display_titlestring运行的显示标题
run_started_atstring运行开始时间戳
created_atstring工作流运行创建时间戳
updated_atstring工作流运行最后更新时间戳
html_urlstring工作流运行 HTML URL
check_suite_idnumber关联检查套件 ID
check_suite_node_idstring关联检查套件节点 ID
urlstring工作流运行 API URL
actorobject
triggering_actorobject
repositoryobject
head_repositoryobject
head_commitobject
pull_requestsarray关联的拉取请求数组
referenced_workflowsarray引用的工作流运行数组
workflowobject
idnumber工作流 ID
node_idstring工作流节点 ID
namestring工作流名称
pathstring工作流文件路径
statestring工作流状态（active、deleted、disabled_fork 等）
created_atstring工作流创建时间戳
updated_atstring工作流最后更新时间戳
urlstring工作流 API URL
html_urlstring工作流 HTML URL
badge_urlstring工作流徽章 URL
repositoryobject
idnumber仓库 ID
node_idstring仓库节点 ID
namestring仓库名称
full_namestring仓库全名（owner/repo）
privateboolean仓库是否为私有
html_urlstring仓库 HTML URL
repo_descriptionstring仓库描述
ownerobject
senderobject
loginstring用户名
idnumber用户 ID
node_idstring用户节点 ID
avatar_urlstring头像 URL
html_urlstring个人资料 URL
user_typestring用户类型（User、Bot、Organization）
通用触发器Gmail 触发器

On this page

事件
GitHub Webhook
设置说明
输出架构
GitHub 议题已打开
设置说明
输出架构
GitHub Issue 已关闭
设置说明
输出结构
GitHub Issue 评论
设置说明
输出结构
GitHub PR 已打开
设置说明
输出结构
GitHub PR 关闭
设置说明
输出结构
GitHub PR 已合并
设置说明
输出架构
GitHub PR 评论
设置说明
输出结构
GitHub PR 审查
设置说明
输出架构
GitHub 推送
设置说明
输出架构
GitHub 发行版已发布
设置说明
输出结构
GitHub Actions 工作流运行
设置说明
输出架构