定義訊息前和訊息後 webhooks 的驗證方法

本文件展示了在 watsonx Assistant 中為訊息前 webhooks 和訊息後 webhooks 配置驗證的過程。 它涵蓋可用的驗證方法以及如何設定它們。

概觀

Webhooks 允許外部系統與 watsonx Assistant 進行通訊。 驗證可確保只有授權來源才能觸發 webhooks。 本文件描述了配置和管理 webhook 身份验证的流程，其中引入了用于验证 webhook 的更新方法。

開始之前

在您設定 webhook 驗證之前：

  • 您必須在環境中擁有寫入權限。
  • 您必須有目標伺服器的驗證詳細資料，包括令牌請求 URL (如果需要) 和任何秘密，例如密碼或令牌。

程序

  1. 移至首頁 > 環境。

  2. 從 「草稿」標籤 > “草稿環境” 或 「即時」標籤 > “即時環境” 中選擇 「設定齒輪圖示」。

  3. 根據您想要定義的內容，選擇訊息前 webhook 或訊息後 webhook。

  4. 向下捲動至 Webhook 設定，並貼上 API URL。

  5. 按一下 Edit authentication（編輯驗證 ），開啟 Authentication（驗證）設定頁面。

  6. 在下拉式選單中，選擇下列其中一個選項：

  7. 按一下儲存。

無鑑別

此為預設選項。

基本鑑別

  1. 輸入使用者名稱和密碼。

承載者認證

  1. 輸入不記名令牌。

API 金鑰認證

  1. 輸入 API 金鑰名稱和 API 金鑰。

簽署 JWT

  1. 進入秘密
  2. 按一下 Show password（顯示密碼 ）圖示 View（檢視）圖示 以檢視密碼。

OAuth 2.0

如果使用 Scope 字串，它必須是目標伺服器定義的一個或多個驗證範圍的空格分隔集。 例如，寫、讀+寫、電子郵件-讀等等。

  1. 在「授權類型」中，選擇下列其中一個選項：

  2. 按一下儲存。

密碼

  1. 輸入 webhook 的使用者名稱。

  2. 輸入 webhook 服務的密碼。

  3. 輸入 Webhook 驗證服務的用戶端 ID。

  4. 輸入用戶端密碼驗證您的 webhook。

  5. 輸入令牌 URL。

  6. 輸入刷新代碼 URL。

  7. 可選： 如果您的服務需要範圍字串，請輸入目標伺服器定義的範圍字串。

  8. 在用戶端驗證中，您必須選擇下列其中一個選項：

    • 作為 Basic Auth 標頭傳送： 驗證憑證將在 HTTP 標頭中傳送。
    • 作為正文傳送： 驗證憑證將在要求正文中傳送。

  9. 輸入標頭前綴，例如：Bearer.

用戶端認證

  1. 輸入 Webhook 驗證服務的用戶端 ID。

  2. 輸入用戶端密碼驗證您的 webhook。

  3. 輸入令牌 URL。

  4. 輸入刷新代碼 URL。

  5. 可選： 如果您的服務需要範圍字串，請輸入目標伺服器定義的範圍字串。

  6. 在用戶端驗證中，您必須選擇下列其中一個選項：

    • 作為 Basic Auth 標頭傳送： 驗證憑證將在 HTTP 標頭中傳送。
    • 作為正文傳送： 驗證憑證將在要求正文中傳送。

  7. 輸入標頭前綴，例如：Bearer.

授權碼

  1. 輸入 Webhook 驗證服務的用戶端 ID。

  2. 輸入授權伺服器 URL。

  3. 輸入令牌 URL。

  4. 輸入刷新代碼 URL。

  5. 可選： 如果您的服務需要範圍字串，請輸入目標伺服器定義的範圍字串。

  6. 在用戶端驗證中，您必須選擇下列其中一個選項：

    • 作為 Basic Auth 標頭傳送： 驗證憑證將在 HTTP 標頭中傳送。
    • 作為正文傳送： 驗證憑證將在要求正文中傳送。

  7. 輸入標頭前綴，例如：Bearer.

  8. 可選： 視目標伺服器而定，複製 Redirect url 到您 OAuth 應用程式的「Callback URL」欄位。

  9. 按一下「授權存取」。

  10. 完成授予伺服器所顯示頁面上的步驟。

  11. 您會被重新導回助手，編輯模式會重新開啟。

  12. 現在該欄位可見，請在 「客戶端 ID」 下輸入客戶端機密。

自訂

  1. 輸入 webhook 的自訂授予類型名稱。

  2. 輸入令牌 URL。

  3. 輸入刷新代碼 URL。

  4. 可選： 如果您的服務需要範圍字串，請輸入目標伺服器定義的範圍字串。

  5. 在用戶端驗證中，您必須選擇下列其中一個選項：

    • 作為 Basic Auth 標頭傳送： 驗證憑證將在 HTTP 標頭中傳送。
    • 作為正文傳送： 驗證憑證將在要求正文中傳送。

  6. 輸入標頭前綴，例如：Bearer.

如果您需要在應用程式中加入自訂秘密，請遵循以下步驟：

  1. 按一下新增秘密 +。

  2. 輸入 Secret name（密碼名稱 ）和 Secret value（密碼值 ）。

  3. 可選： 如果您要新增更多秘訣名稱和秘訣值，請按一下新增秘訣 +。

  4. 按一下新增參數 +。

  5. 輸入參數名稱和參數值。

  6. 可選： 如果要新增更多參數名稱和參數值，請按一下新增參數 +。