如何读取Jenkins Web Hook POST请求体并传递至脚本？

嘿，你的需求刚好可以用Generic Webhook Trigger Plugin完美解决！我之前也遇到过类似的场景，这个插件简直是为这种Web Hook传递数据的需求量身定做的。下面一步步给你讲清楚怎么弄：

这个插件的核心能力就是解析Web Hook发送的POST请求体，把你需要的数据提取成Jenkins环境变量，不管是Bash还是Python脚本，都能直接调用这些变量——甚至在Build Actions的其他步骤里也能直接访问。

具体配置步骤 #

1. 先安装插件 #

打开Jenkins的「插件管理」页面，搜索并安装Generic Webhook Trigger Plugin，安装完成后重启Jenkins生效。

2. 配置任务的触发规则 #

进入你的Jenkins任务配置页，找到「构建触发器」区域，勾选「Generic Webhook Trigger」：

• 提取单个字段：如果你的请求体是JSON格式（比如{"action": "build", "env": "test"}），在「Post content parameters」里添加参数：
  • 变量名设为ACTION，表达式填$.action，解析方式选「JSON」
  • 变量名设为ENV，表达式填$.env，解析方式选「JSON」
• 获取完整请求体：如果需要拿到整个POST请求的body内容，直接设置变量名REQUEST_BODY，表达式填$（JSON根节点），解析方式选「JSON」即可。如果是表单格式（x-www-form-urlencoded），直接填对应的参数名就行。
• 别忘了设置触发令牌（Token），用来验证请求的合法性，避免恶意触发。

3. 在脚本/ Build Actions中访问数据 #

Bash脚本示例

在「执行 shell」步骤里，直接用环境变量就能调用：

#!/bin/bash
echo "当前执行的操作: $ACTION"
echo "目标环境: $ENV"

# 如果拿到了完整请求体，可以写入文件再处理
echo "$REQUEST_BODY" > request_body.json
# 用jq工具解析JSON（需要提前安装jq）
TARGET_PROJECT=$(jq -r '.project' request_body.json)
echo "目标项目: $TARGET_PROJECT"

Python脚本示例

通过os模块读取环境变量即可：

import os
import json

# 获取单个参数
action = os.getenv('ACTION')
env = os.getenv('ENV')
print(f"触发操作: {action}")
print(f"部署环境: {env}")

# 解析完整请求体
raw_body = os.getenv('REQUEST_BODY')
if raw_body:
    body_data = json.loads(raw_body)
    print(f"完整请求数据: {body_data}")

4. 测试触发 #

用curl模拟POST请求测试是否能正确提取数据：

curl -X POST -H "Content-Type: application/json" -d '{"action": "deploy", "env": "prod", "project": "my-app"}' http://你的Jenkins地址/generic-webhook-trigger/invoke?token=你的触发令牌

关于Build Actions的访问问题 #

当然可以！你配置的这些环境变量在任务的所有Build Actions中都能直接访问——不管是执行脚本、发送邮件、调用其他子任务，只要是任务里的步骤，都可以直接用$ACTION、$REQUEST_BODY这类变量。

额外小贴士 #

• 如果请求体是XML格式，插件支持用XPath表达式提取数据，配置时选「XML」解析方式即可
• 如果Jenkins部署在内网，要确保Web Hook的发送方能访问到Jenkins的地址（可能需要做端口映射或反向代理）
• 建议给触发请求添加令牌验证，防止无关请求触发任务

内容的提问来源于stack exchange，提问作者fuzzi