第 18 章 使用 Webhook
Webhook 是网页或 Web 应用程序为其他应用程序实时提供信息的一种方法。Webhook 仅在事件发生后触发。请求通常包含事件的详细信息。事件触发回调，如发送确认主机已调配的电子邮件。您可以使用 webhook 使用 fire-and-forget 消息交换模式，根据 Satellite 内部事件定义对外部 API 的调用。发送请求的应用不会等待响应，或者忽略它。
Webhook 的有效负载是从 Webhook 模板创建的。Webhook 模板使用与 Provisioning 模板相同的 ERB 语法。可用变量：
-
@event_name：事件的名称。 -
@webhook_id：唯一事件 ID。 -
@payload: Payload data，每个事件类型都不同。要访问各个字段，请使用@payload[:key_name]Ruby hash 语法。 -
@payload[:object]: Database object 用于由数据库操作(create、update、delete)触发的事件。不适用于自定义事件。 -
@payload[:context]: 附加信息作为哈希，如请求和会话 UUID、远程 IP 地址、用户、机构和位置。
由于 Webhook 使用 HTTP，因此不需要向现有 Web 服务添加新的基础架构。
Satellite 中 webhook 的典型用例是在创建或删除主机时调用监控系统。
Webhook 非常有用，在外部系统中要执行的操作可以通过其 API 来实现。如果需要运行其他命令或编辑文件，则胶囊的 shellhooks 插件可用。shellhooks 插件允许您在胶囊上定义可通过 API 执行的 shell 脚本。
您可以在不安装 shellhooks 插件的情况下成功使用 Webhook。
有关可用事件列表，请参阅 可用的 Webhook 事件。
18.1. 迁移到 Webhook
传统的 foreman_hooks 插件提供对 webhook 插件不有意提供的模型对象的完整访问权限。
安全模式以及所有对象和宏都限制可用的范围，它们都受到 API 稳定性承诺的影响，并完全记录。
Webhook 触发的事件数量显著低于 foreman_hooks。
Webhook 异步处理，因此对系统内部的篡改的风险很小。在为每个单独的 webhook 脚本创建有效负载的情况下，无法从 foreman_hooks 迁移。但是，webhook 插件会附带几个示例有效负载模板。您还可以在 shellhooks 中使用示例有效负载来简化迁移。
必须自定义脚本和有效负载模板才能实现类似的结果。
