Webhook - 案例管理连接器和操作
编辑Webhook - 案例管理连接器和操作编辑
Webhook - 案例管理连接器使用 axios 向案例管理 RESTful API Web 服务发送 POST、PUT 和 GET 请求。
在 Kibana 中创建连接器编辑
您可以在 堆栈管理 > 连接器 中创建连接器,或者在创建规则时根据需要创建。在第一步中,您必须为连接器提供名称及其身份验证详细信息。例如
在第二步中,您必须提供在外部系统中创建案例所需的信息。例如
在第三步中,您必须提供与从外部系统检索案例详细信息相关的信息。例如
在第四步中,您必须提供在外部系统中更新案例所需的信息。您还可以选择提供信息以向案例添加评论。例如
连接器配置编辑
Webhook - 案例管理连接器具有以下配置属性
- 添加 HTTP 标头
- 一组键值对,作为标头发送到创建案例、更新案例、获取案例和创建评论方法的请求 URL。例如,将
Content-Type
设置为请求的适当媒体类型。 - 创建案例方法
- 在第三方系统中创建案例的 REST API HTTP 请求方法:
post
(默认)、put
或patch
。 - 创建案例对象
-
发送到创建案例 URL 以创建案例的 JSON 负载。使用变量选择器将案例数据添加到负载中。必需变量是
case.title
和case.description
。例如{ "fields": { "summary": {{{case.title}}}, "description": {{{case.description}}}, "labels": {{{case.tags}}} } }
由于 Mustache 模板变量(用三花括号括起来的文本,例如
{{{case.title}}}
),JSON 在此步骤中不会被验证。在 REST 方法运行时放置 Mustache 变量后,将验证 JSON。手动确保 JSON 有效,忽略 Mustache 变量,以便以后的验证通过。 - 创建案例响应外部键
- 创建外部案例响应中包含案例 ID 的 JSON 键。
- 创建案例 URL
- 在第三方系统中创建案例的 REST API URL。如果您使用的是
xpack.actions.allowedHosts
设置,请确保主机名已添加到允许的主机中。 - 创建评论方法
- 在第三方系统中创建案例评论的可选 REST API HTTP 请求方法:
post
、put
(默认)或patch
。 - 创建评论对象
-
发送到创建评论 URL 以创建案例评论的可选 JSON 负载。使用变量选择器将 Kibana 案例数据添加到负载中。必需变量是
case.comment
。例如{ "body": {{{case.comment}}} }
由于 Mustache 模板变量(用三花括号括起来的文本,例如
{{{case.title}}}
),JSON 在此步骤中不会被验证。在放置 Mustache 变量后以及 REST 方法运行时,将验证 JSON。我们建议手动确保 JSON 有效,忽略 Mustache 变量,以便以后的验证通过。 - 创建评论 URL
-
在第三方系统中通过 ID 创建案例评论的可选 REST API URL。使用变量选择器将外部系统 ID 添加到 URL。如果您使用的是
xpack.actions.allowedHosts
设置,请确保主机名已添加到允许的主机中。例如https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}/comment
- 外部案例视图 URL
-
在外部系统中查看案例的 URL。使用变量选择器将外部系统 ID 或外部系统标题添加到 URL。例如
https://testing-jira.atlassian.net/browse/{{{external.system.title}}}
- 获取案例响应外部标题键
- 获取外部案例响应中包含案例标题的 JSON 键。
- 获取案例 URL
-
从第三方系统通过 ID 获取案例的 REST API URL。使用变量选择器将外部系统 ID 添加到 URL。如果您使用的是
xpack.actions.allowedHosts
设置,请确保主机名已添加到允许的主机中。例如https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}
由于 Mustache 模板变量(用三花括号括起来的文本,例如
{{{case.title}}}
),JSON 在此步骤中不会被验证。在 REST 方法运行时放置 Mustache 变量后,将验证 JSON。手动确保 JSON 有效,忽略 Mustache 变量,以便以后的验证通过。 - 需要身份验证
- 如果为 true,则必须提供用于登录类型身份验证的用户名和密码。
- 密码
- HTTP 基本身份验证的密码。
- 更新案例方法
- 在第三方系统中更新案例的 REST API HTTP 请求方法:
post
、put
(默认)或patch
。 - 更新案例对象
-
发送到更新案例 URL 以更新案例的 JSON 负载。使用变量选择器将 {Kibana} 案例数据添加到负载中。必需变量是
case.title
和case.description
。例如{ "fields": { "summary": {{{case.title}}}, "description": {{{case.description}}}, "labels": {{{case.tags}}} } }
由于 Mustache 模板变量(用三花括号括起来的文本,例如
{{{case.title}}}
),JSON 在此步骤中不会被验证。在 REST 方法运行时放置 Mustache 变量后,将验证 JSON。手动确保 JSON 有效,以避免以后的验证错误;在您的审查过程中忽略 Mustache 变量。 - 更新案例 URL
-
在第三方系统中通过 ID 更新案例的 REST API URL。使用变量选择器将外部系统 ID 添加到 URL。如果您使用的是
xpack.actions.allowedHosts
设置,请确保主机名已添加到允许的主机中。例如https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.ID}}}
- 用户名
- HTTP 基本身份验证的用户名。
测试连接器编辑
您可以使用 运行连接器 API 测试连接器,或者在 Kibana 中创建或编辑连接器时进行测试。例如
Webhook - 案例管理操作具有以下配置属性
- 其他评论
- 有关客户端的其他信息,例如如何解决问题。
- 描述
- 有关事件的详细信息。
- 标签
- 事件的标签。
- 标题
- 问题的标题,用于搜索知识库的内容。
连接器网络配置编辑
使用 操作配置设置 自定义连接器网络配置,例如代理、证书或 TLS 设置。您可以设置适用于所有连接器的配置,或者使用 xpack.actions.customHostSettings
设置每个主机的配置。