Webhook
資料異動時讓客脈把事件送到你的網址:新增 Webhook、選擇事件、保存簽章密鑰、傳送測試事件、查看傳送紀錄與重送。
Webhook 讓你的系統在客脈的資料有異動時馬上收到通知,不必每隔幾分鐘來查一次。例如商機換階段時通知 ERP、新增聯絡人時通知 Zapier。
新增 Webhook
- 開啟使用者選單,點選「API 與 Webhook」,進入「Webhook」分頁。
- 按「新增 Webhook」。
- 填「名稱」,例如「Zapier 新商機」。
- 填「網址」:接收事件的網址,必須是
https://開頭的公開網域名稱,例如 Zapier、Make 提供的網址或你自己的伺服器。 - 勾選「訂閱的事件」,至少一種。
- 按「新增」。
- 畫面會顯示「簽章密鑰」(
whsec_開頭)。按「複製」,設定到接收端,再按「我已經保存好了」。
網址的限制:只接受 https://、預設的連接埠、網域名稱(不能直接填 IP 位址),不能是 localhost 或內部網域;網域也不能解析到私有或內部位址。
可以訂閱的事件
| 事件 | 什麼時候送出 |
|---|---|
| 公司建立 | 新增公司時(含匯入 CSV) |
| 公司修改 | 修改公司的欄位、負責人或自訂欄位時 |
| 公司刪除 | 刪除公司時 |
| 聯絡人建立 | 新增聯絡人時(含匯入 CSV) |
| 聯絡人修改 | 修改聯絡人的欄位、負責人或自訂欄位時 |
| 聯絡人刪除 | 刪除聯絡人時 |
| 商機建立 | 新增商機時 |
| 商機修改 | 修改商機的欄位、負責人或自訂欄位時 |
| 商機刪除 | 刪除商機時 |
| 商機換階段 | 商機移到別的階段時(含成交、失敗) |
| 新增活動紀錄 | 在公司、聯絡人或商機新增活動紀錄時 |
| 待辦建立 | 新增待辦時 |
| 待辦完成 | 待辦標成完成時 |
不論是畫面操作、匯入、自動化流程或經由 API Key 做的變更,都會送出事件;只改標籤不會送出「修改」事件。事件內容只有事件類型與資料的 id,需要完整資料時,接收端再用 API Key 讀取。
管理 Webhook
在「Webhook」分頁點選 Webhook 的名稱,可以:
- 修改名稱、網址與訂閱的事件,按「儲存」。之後的事件才會套用。
- 啟用或停用:停用期間的事件不會送出,之後重新啟用也不會補送。
- 按「傳送測試事件」:送一個測試事件到網址,確認接收端設定正確。
- 按「重新產生簽章密鑰」:舊的密鑰會立即失效,接收端要改用新的密鑰。
- 按「刪除」:之後不會再傳送事件,傳送紀錄也一併刪除,而且無法復原。
傳送紀錄與重送
Webhook 頁面下方是「最近的傳送紀錄」,列出最近 100 次傳送的時間、事件、結果(傳送中、成功、失敗)、對方回應的狀態與耗時。按「重新整理」看最新的結果。
- 接收端要在 10 秒內回應
2xx(例如200)才算成功。 - 失敗時客脈會自動重試,間隔逐漸拉長,總共最多 5 次;都失敗才算「失敗」。
- 失敗的傳送可以按「重送」,用同一個事件再送一次。
- 傳送紀錄保留 30 天。
自動停用
連續 20 次傳送失敗時,Webhook 會自動停用,並通知擁有者與管理員。通常是網址改了、接收端故障或憑證過期。
請先確認接收端可以正常接收,再到 Webhook 頁面按「啟用」;啟用後重新計算失敗次數。停用期間的事件不會補送,需要時可以在傳送紀錄按「重送」。