18.3. 创建 Webhook 模板
Webhook 模板用于在触发 webhook 时生成到配置的目标的 HTTP 请求的正文。使用以下步骤在 Satellite Web UI 中创建 Webhook 模板。
流程
- 在 Satellite Web UI 中，进入到 Administer > Webhook Templates。
- 单击 Clone an existing template 或 Create Template。
- 输入模板的名称。
使用编辑器更改模板有效负载。
必须使用 Satellite 模板语法创建 webhook HTTP 有效负载。Webhook 模板可以使用一个名为
@object的特殊变量，它可以代表事件的主对象。如果特定事件，可以缺少@object。您可以通过@payload变量确定实际可用的数据。如需更多信息， 请参阅管理主机中的模板编写参考 ，以及可用的模板宏和方法，请访问 Satellite 服务器上的
/templates_doc。- 可选：输入 description 和 audit 注释。
- 分配机构和位置。
- 点 Submit。
例子
在创建 webhook 模板时，您必须遵循模板的目标应用程序格式。例如，应用程序可以预期带有 Webhook 消息的 "文本" 字段。请参阅目标应用程序的文档，以了解更多有关 webhook 模板格式的信息。
- 运行远程执行作业
此 webhook 模板定义了带有远程执行作业的 ID 和结果的消息。使用此模板的 Webhook 可以订阅到事件，如
Actions Remote Execution Run Host Job Succeeded或Actions Remote Execution Run Host Job Failed。{ "text": "job invocation <%= @object.job_invocation_id %> finished with result <%= @object.task.result %>" }- 创建用户
此 webhook 模板定义了包含已创建用户的登录和电子邮件的消息。使用此模板的 Webhook 应订阅到
User Created事件。{ "text": "user with login <%= @object.login %> and email <%= @object.mail %> created" }
