Webhook管理

一、何謂Webhook

Webhook 是一種自動通知機制，能在 UOF X 發生特定事件時，主動將事件通知即時推送到外部系統。

透過 Webhook：

• UOF X 可以安全地將事件資料傳送給外部系統。
• 外部系統也能透過驗證機制，確認身分後再存取 UOF X 資料。

二、使用Webhook管理的情境

Webhook 適合用於系統整合、流程自動化及即時通知等應用情境，當公司有以下需求時，可使用 Webhook 管理功能：

• 希望在 UOF X 發生事件時即時通知外部系統。
• 需要將 UOF X 的事件與 其他系統進行整合。
• 由系統自動傳送通知，不需人工操作或定期查詢。
• 需要確保通知與資料存取過程具備身分驗證與安全性。

三、如何建立與管理 Webhook

目前UOF X 提供 [文件異動事件] ，在建立訂閱事件之前，請先確認相關文件庫已勾選 [允許 Webhook 發送通知] ，否則無法在[文件異動事件]選到相關文件庫，觸發後續發送通知至外部系統流程。

A. 建立前準備：開啟[文件庫]授權功能

• 文件中心管理員可以前往 [文件庫管理] ，據組織需求，決定[文件庫]是否 允許透過 Webhook 發送通知 。
• 僅開啟授權的文件庫，才能被 Webhook [文件異動事件] 使用。
• 取消勾選時，該文件庫將會從 [文件異動事件] 所選擇的文件庫清單中移除，立即生效。

  

B. Webhook管理

路徑：管理者首頁>系統管理>Webhook管理

1. 完成文件庫授權準備後， 公司管理員在 可以在 Webhook管理 建立與管理 Webhook Channel。

   

2. 透過以下步驟設定Webhook訂閱資訊：

   Step1 - 一般設定

   • 名稱 ：可以識別這個頻道的用途， 不允許重複 。
   • Webhook URL ：接收 Webhook 的外部端點，可以進行[測試]驗證連線是否成功。
   • 金鑰1-Secret(HMAC) ：用於 UOF X 發出通知的簽章驗證 (外面系統要認得UOF X)，以自動產生、複製。
   • 金鑰2-AccessToken ：用於外部系統呼叫 UOF X 的身分識別(UOF X要認得外部系統)，以自動產生、複製。

   • 備註 ：提供輸入備註文字。

     
     

   Step2 - 設定訂閱事件

   • 文件異動事件 ：需要先開啟對應[文件庫]讀取權限，才可以在 [文件異動事件] 選擇到該文件庫，允許選擇多個文件庫。