關鍵要點
我們正在透過引入 webhook 來擴展我們的 API 功能
Webhook 將為我們的客戶提供主動、即時通知,並增強他們管理資料更新的能力
透過註冊訂閱,用戶將自動收到有關所選記錄的變更、新增或刪除的通知
該功能將向員工 API 使用者開放
我們很高興地宣布實作了 webhook,這是 台灣數據 我們 API 功能套件的最新成員。 Webhook 允許使用者註冊員工 API 標準端點的訂閱,一旦激活,將自動通知使用者符合其指定條件或 ID 清單的記錄(設定檔)的變更、新增或刪除。
該功能適用於購買每月 1500 美元起套餐的客戶。
Webhook 訂閱對於以下用例特別有益:
根據您的標準發現新記錄
接收選定記錄變更的警報
刪除不再符合條件的記錄,以保持清單最新
它是如何運作的?
API 用戶端現在可以透過查詢新的訂閱端點並使用以下三個輸入選項中的任何一個來縮小相關記錄來建立訂閱:
搜尋過濾器參數
Elasticsearch DSL 查詢
個人資料 ID 列表
一旦設定,訂閱將開始定期向指定的回調 URL 發送基於事件的變更通知(HTTP POST 請求)。觸發事件是更改、新增或刪除記錄。
Webhook 通知包含以下資訊:
設定檔 ID
更改類型
整體流程如下:
選擇您要追蹤的個人資料
提供回呼 URL 以接收通知
接收發送至指定 URL 的通知
收集最新數據的數據記錄
預設情況下,訂閱有效期為 90 天,一次訂閱最多可追蹤 100 萬筆資料記錄。
為什麼要使用 webhook 訂閱?
Webhook 原理簡單,解決了企業在使用 API 收集資料時遇到的一些常見痛點,主要有:
1. Webhook 訂閱消除了維護計劃的、次優的查詢來檢查更新的需要。
2.收集冗餘資料。以前,客戶端只能依賴last_updated時間戳,但這並不一定表示資料的實際變化。這可能導致收集相同的記錄。透過引入 webhook,我們確保僅發送有關更改的設定檔的通知。
其他好處包括提高資料新鮮度、為新客戶改進和簡化 API 集成,以及減少現有客戶的工作流程冗餘。