Webhooks 集成

Site24x7 让您可以轻松使用 Webhooks 将 Site24x7 事件与多个应用程序连接。Webhooks 基于事件驱动的输出机制运作。Site24x7 中产生的特定事件（例如监视器状态变为故障或严重）将触发 Webhook，并通过 HTTPS 请求向 Hook URL 发送信号。Site24x7 中的任何触发事件都会将事件数据发布到指定的 Hook URL。这使您能够在任何第三方应用程序中统一管理 Site24x7 的关键告警、告警事件或消息。此外，通过我们的本地轮询器对 Webhook 集成的支持，您还可以将事件信息发布到任何内部应用程序。

使用 Webhooks 将 Site24x7 与第三方应用集成

Webhook 集成需要您获取目标第三方服务的 Hook URL。获取 Hook URL 后，请按照以下步骤，使用 Webhooks 将 Site24x7 事件数据与任何第三方应用程序紧密集成：

1. 登录 Site24x7。
2. 导航至管理 >第三方集成。
3. 点击加号按钮 + 和添加第三方集成按钮，从列表中选择 Webhooks。
   
   
4. 填写 Webhooks 集成表单以完成集成过程。
   
   • 集成名称：为您的集成提供一个名称。
   • Hook URL：Site24x7 发送数据的完整 URL（包含 http/https 协议）。来自 Site24x7 的告警将触发 Webhook，将事件发布到此 URL。
   • HTTP 方法：指定连接 URL 时使用的方法——GET、POST、PUT、DELETE 或 PATCH。选择单选按钮以配置表单提交方式以及 POST、PUT、DELETE 或 PATCH HTTP 方法的相应正文类型。
     • 以 JSON 格式发送： 在 JSON 请求正文中输入要提交的内容，Content-Type 请求头将自动设置。
     • 发送告警参数：在 URL 中直接编写特定代码，并通过告警参数传递变量。HTTP 方法的请求参数必须以参数名=值对的形式提供。了解更多关于告警参数的信息。
       
       注意

       $INCIDENT_DETAILS 目前仅适用于 RBL 监视器。

     • 发送自定义参数：编写特定代码，以参数名=值对的格式为 HTTP CRUD 方法传递参数。如果需要传递多个键值对，每对之间必须单独占一行，并在每行末尾加上 & 符号。您也可以以 JSON 格式发送请求。在 HTTP 请求中传递自定义参数时，可以在"名称"或"值"字段中指定预定义的全局参数。全局参数将在 HTTP 响应中替换为您定义的常量或实际动态值。了解更多关于自定义参数的信息。 
       自定义参数应使用以下任一语法传递： 

     以 JSON 格式指定时的自定义参数语法：

     

     非 JSON 格式指定时的自定义参数语法：  

     
   • 启用参数编码：使用此开关控制参数值在请求中发送之前是否进行编码。
     • 设置为是时，将在发送请求前对所有参数和表单值进行编码。
     • 设置为否时，将按照输入的原始内容发送参数和表单值，不进行编码。
       
   • 要编码的 JSONPath 表达式：提供要编码的 JSONPath 表达式，从 JSON 结构的根节点开始导航到特定键。仅当同时选择了以 JSON 格式发送和发送自定义参数选项时，该字段才可用。
   • 可访问性： 决定 Hook URL 是从 Site24x7 全球服务器调用，还是通过本地轮询器在网络内部调用。
     • 全局： 从 Site24x7 中央服务器调用 Hook URL 以执行集成。
     • 内部： 需要本地轮询器来执行集成。配置完成后，中央服务器将通知本地轮询器调用 Hook URL 以完成集成。
       
       注意

       要配置本地轮询器，请按照此说明操作。

   • 选择轮询器类型：决定此集成的告警通知路由方式。仅当在可访问性中选择内部时，此选项才可用。您有两个选项可通过本地监控设置路由告警：
     
     • 本地轮询器：如果您希望通过单个专用本地轮询器发送告警，请选择此选项。告警将仅通过所选的轮询器路由。了解更多关于本地轮询器的信息。
     • 本地轮询器组：选择此选项可分配一组轮询器，而不是单个轮询器。了解更多关于本地轮询器组的信息。
       
       注意

       轮询器组中的所有轮询器，以及高可用轮询器配置中的轮询器（主轮询器和备用轮询器），都必须能够访问第三方服务（ServiceDesk Plus 或 ServiceDesk Plus MSP 的本地版本）。

   • HTTP 请求头：有时您可能需要自定义默认的 HTTP 请求头信息。在这种情况下，可以在此处添加额外的请求头名称和请求头值。
   • User Agent： 为发送请求和 HTTP 请求头设置自定义用户代理（Web 浏览器），您可以从可用的用户代理中进行选择。
   • 认证方式：点击单选按钮并相应更新凭据。
     • Basic/NTLM 凭据：配置 Basic/NTLM 授权方式。Windows NTLM 是 Windows 操作系统上使用的认证协议。
       • 凭据： 为需要 Basic/NTLM 认证的 URL 指定您的用户名和密码。
     • OAuth：如果您要监控由 OAuth 框架保护的资源，请选择 OAuth 单选按钮。
       • 提供者名称： 从预配置列表中选择 OAuth 提供者名称，或点击 + 按钮创建新的 OAuth 配置文件。
         
         注意

         了解如何配置 OAuth 提供者。

     • GCP Service Account Key：如果您希望通过 Webhook 将告警事件推送到需要通过 Google Cloud Service Account 进行认证的 Google Cloud API，请选择 GCP Service Account Key 单选按钮。
       
       • GCP Service Account：选择已使用 GCP Service Account Key JSON 文件添加的适当 GCP 监视器，或点击 + 按钮添加新的 GCP 监视器并上传相关的 GCP Service Account Key JSON 文件。
         
         注意

         了解如何配置 GCP 监视器。

     • Web Token：Web Token 为 API 和受保护资源提供安全认证。如果您希望通过 Web Token 访问资源，请选择此选项。
       • Web Token：从预配置列表中选择 Web Token，或点击 + 按钮创建新的 Web Token 配置文件。了解关于添加 Web Token 的信息。
   • 超时：输入时间（秒），确定 Site24x7 服务器在认为 URL 无响应之前等待的时长。请输入与您网站通常响应时间不同的秒数，指定 1-45 秒之间的值。
   • 集成级别：选择您偏好的集成级别，以从 Site24x7 账户向相关 Webhook 发送告警。
     • 监视器：选择至少一个特定监视器，以仅从该监视器向 Webhook 发送告警和 RCA 链接。
     • 标签：选择至少一个特定标签，以将对应该标签的 Site24x7 告警和 RCA 链接发送到 Webhook。
     • 监视器组：选择至少一个监视器组，以将来自该组的告警和 RCA 链接发送到指定 Webhook。
     • 所有监视器：您可以选择将所有 Site24x7 告警和 RCA 链接发送到 Webhook。
       
       注意

       如果您的监视器组包含带有父监视器的标签以及子组中的部分监视器，则仅父监视器的告警将被发送到您偏好的第三方服务。

   • 随告警发送的标签：选择与监视器关联的需要随告警发送的标签键。当触发告警时，与监视器匹配的标签将包含在告警通知中。如果未选择任何标签，则与监视器关联的所有标签都将出现在告警通知中。
   • 备用通知：如果发送告警的主要通知方式失败，将使用此备用服务发送通知，确保告警不会遗漏。
   • 监视器状态变更触发告警：使用复选框选择您希望接收告警的监视器状态变更（宕机、故障和严重）。至少选择一个状态以启用集成。
5. 点击保存并测试按钮，保存集成并接收测试告警。您也可以点击保存按钮完成集成。
   
   注意

   完成配置后，Webhooks 集成将显示在第三方集成仪表板中。您可以在 Site24x7 账户中配置多个此类 Webhook。 

暂停/激活/测试告警/删除 Webhooks 集成

按照以下步骤暂停一个活跃的 Webhook 集成：

1. 登录 Site24x7。
2. 导航至管理 >第三方集成。
   
   注意

   所有集成将显示在第三方集成仪表板列表页面中。

3. 点击触发测试告警 按钮，发起测试告警，检查集成是否成功或是否存在配置错误。

4. 打开您要暂停的活跃 Webhook 集成，点击集成窗口右上角的暂停按钮。
   
   

   注意

   • 当您的 Webhook 集成被暂停时，发送到 Webhook 账户的所有事件工单将暂时停止。
   • 要重新激活已暂停的 Webhook 集成，请点击激活按钮。 
5. 要永久删除集成，请打开活跃的 Webhook 集成，点击集成窗口右上角的删除按钮。