概述

Webhooks 允许外部系统与 watsonx Assistant 通信。 身份验证可确保只有授权来源才能触发网络钩子。 本文档介绍了配置和管理网络钩子身份验证的流程，其中引入了一种更新的网络钩子身份验证方法。

准备工作

在配置 Webhook 身份验证之前：

• 您必须在环境中拥有写入权限。
• 您必须有目标服务器的身份验证详细信息，包括令牌请求 URL（如需要）和任何秘密，如密码或令牌。

过程

1. 转到主页 > 环境。

2. 从 "草稿 "选项卡 >" 草稿环境 "或 " 实时 "选项卡 >" 实时环境 "中选择 " 设置 。

3. 根据要定义的内容，选择“**信息前网络钩子 **”或“信息后网络钩子”。

4. 向下滚动到 Webhook 设置，然后粘贴 API URL。

5. 单击编辑身份验证打开身份验证设置页面。

6. 在下拉菜单中，选择以下选项之一：

   • 不认证
   • 基本认证
   • 承载者认证
   • API 密钥认证
   • OAuth 2.0
   • 签署 JWT

7. 单击保存。

密码

1. 输入网络钩子的用户名。

2. 输入 webhook 服务的密码。

3. 输入 Webhook 身份验证服务的客户端 ID。

4. 输入客户端密文以验证网络钩子。

5. 输入令牌 URL。

6. 输入刷新令牌 URL。

7. 可选： 如果服务需要范围字符串，请输入目标服务器定义的范围字符串。

8. 在客户端身份验证中，您必须选择以下选项之一：

   • 作为 Basic Auth 头信息发送： 认证凭据将在 HTTP 标头中发送。
   • 作为正文发送： 身份验证凭据将在请求正文中发送。

9. 输入标题前缀，例如承载器。

客户机凭证

1. 输入 Webhook 身份验证服务的客户端 ID。

2. 输入客户端密文以验证网络钩子。

3. 输入令牌 URL。

4. 输入刷新令牌 URL。

5. 可选： 如果服务需要范围字符串，请输入目标服务器定义的范围字符串。

6. 在客户端身份验证中，您必须选择以下选项之一：

   • 作为 Basic Auth 头信息发送： 认证凭据将在 HTTP 标头中发送。
   • 作为正文发送： 身份验证凭据将在请求正文中发送。

7. 输入标题前缀，例如承载器。

授权代码

1. 输入 Webhook 身份验证服务的客户端 ID。

2. 输入授权服务器 URL。

3. 输入令牌 URL。

4. 输入刷新令牌 URL。

5. 可选： 如果服务需要范围字符串，请输入目标服务器定义的范围字符串。

6. 在客户端身份验证中，您必须选择以下选项之一：

   • 作为 Basic Auth 头信息发送： 认证凭据将在 HTTP 标头中发送。
   • 作为正文发送： 身份验证凭据将在请求正文中发送。

7. 输入标题前缀，例如承载器。

8. 可选： 根据目标服务器的不同，将重定向 url 复制到 OAuth 应用程序的“回调 URL”字段。

9. 单击“授予访问权限”。

10. 完成授予服务器所显示页面上的步骤。

11. 您将被重定向回到助手，编辑模式将重新打开。

12. 在“客户 ID”下输入“客户秘密”，此时该字段可见。

定制

1. 输入 webhook 的自定义授予类型名称。

2. 输入令牌 URL。

3. 输入刷新令牌 URL。

4. 可选： 如果服务需要范围字符串，请输入目标服务器定义的范围字符串。

5. 在客户端身份验证中，您必须选择以下选项之一：

   • 作为 Basic Auth 头信息发送： 认证凭据将在 HTTP 标头中发送。
   • 作为正文发送： 身份验证凭据将在请求正文中发送。

6. 输入标题前缀，例如承载器。

如果需要在应用程序中添加自定义秘密，请按照以下步骤操作：

1. 单击添加秘密 +。

2. 键入秘密名称和秘密值。

3. 可选项： 如果要添加更多秘密名称和秘密值，请单击添加秘密 +。

4. 单击添加参数 +。

5. 键入参数名称和参数值。

6. 可选项： 如果要添加更多参数名和参数值，请单击添加参数 +。