跳轉到

Webhook管理

一、何謂Webhook

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

透過 Webhook:

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

二、使用Webhook管理的情境

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

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

三、Webhook管理流程

💡路徑:管理者首頁>系統管理>Webhook管理

公司管理員在 可以建立與管理 Webhook Channel,透過以下步驟設定Webhook訂閱資訊:

Step1 - 一般設定

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

Image webhook-1

Step2 - 設定訂閱事件

  • 文件異動事件 :需要對應先開啟對應讀取權限,才可以在{文件發布事件}可以選擇到該文件庫,允許複選。

Image webhook-2