跳到主要内容

Webhook

Webhook 组件定义了一个 webhook 触发器:当它收到 HTTP POST 请求时,就会触发当前流程运行。

触发 Webhook

当你把 Webhook 组件加入流程后,流程的 API Access 面板 中会新增一个 Webhook curl 标签页。 该标签页会自动生成一段 HTTP POST 请求代码,你可以直接用它通过 Webhook 组件触发流程,例如:


_10
curl -X POST \
_10
"http://$SKILLFLAW_SERVER_ADDRESS/api/v1/webhook/$FLOW_ID" \
_10
-H 'Content-Type: application/json' \
_10
-H 'x-api-key: $SKILLFLAW_API_KEY' \
_10
-d '{"any": "data"}'

更多说明请参阅通过 webhook 触发流程

Webhook 参数

有些参数在可视化编辑器中默认处于隐藏状态。 你可以通过组件标题栏菜单中的 控件 来修改全部参数。

NameDisplay NameDescription
dataPayload输入参数。通过 HTTP POST 请求接收外部系统传入的负载数据。
curlcurl输入参数。用于调用该 webhook 的 curl 命令模板。
endpointEndpoint输入参数。当前 webhook 接收请求的端点 URL。
output_dataData输出参数。对 webhook 输入完成处理后的数据。如果未提供输入,则返回一个空的 Data 对象;如果输入不是合法 JSON,Webhook 组件会把它包裹进 payload 对象中,以便流程仍可接受并触发执行。