透過 Webhook，應用程式 API 會在聊天工作階段發生相關事件時，即時傳送通知給您的應用程式，例如建立對話、收到訊息，或是轉移或升級對話。使用 Webhook 即可在聊天活動發生時立即做出反應，不必輪詢 API。
Webhook 的範圍僅限於 Apps API 的即時通訊工作階段。Contact Center AI 平台會將所有支援的應用程式 API 即時通訊 Webhook 事件，以 HTTP POST 要求的形式傳送至您設定的單一 Webhook 網址。沒有單一賽事訂閱方案。
事前準備
- 您必須是管理員 (或具備編輯開發人員設定的權限)，才能設定 Webhook。
- 準備可接收 HTTP
POST要求的端點。Webhook 網址必須使用 HTTPS。
開啟 Webhook
開啟 Webhook 後，Contact Center AI 平台會將 Webhook 事件傳送至您設定的網址，並顯示網址和 Secret 欄位。如果停用 Webhook，系統就不會傳送任何事件。
如要啟用 Webhook，請按照下列步驟操作：
- 在 CCAI Platform 入口網站中，依序點選「Settings」>「Developer Settings」。 如果沒有看到「設定」選單，請按一下「選單」圖示 。
- 前往「Webhooks」窗格，然後點選「Webhooks」切換按鈕，將其設為開啟。
設定 Webhook 網址
- 在「URL」中，輸入 Webhook 端點。
- 確認端點使用 HTTPS，且可以接收
POST要求。 Contact Center AI 平台會將所有支援的事件傳送至這個網址。
產生簽署密鑰
Contact Center AI 平台會簽署每個 Webhook 要求，因此您的應用程式可以確認要求來自 Contact Center AI 平台。簽章會透過 X-Signature 要求標頭傳送，簽署時間戳記則透過 X-Signature-Timestamp 傳送。您最多可以設定兩組簽署密鑰：
- 主要密鑰：用於簽署 Webhook 要求的主要權杖。
- 次要密鑰：選用的第二個權杖。設定次要密鑰後，Contact Center AI 平台會使用這兩個密鑰簽署每項要求，讓您輪替密鑰時不會遺漏任何事件。
請分別產生每個密鑰。如要產生密鑰，請按照下列步驟操作：
- 在 CCAI Platform 入口網站中，依序點選「Settings」>「Developer Settings」。 如果沒有看到「設定」選單，請按一下「選單」圖示 。
- 前往「Webhooks」窗格。
- 在「Primary Secret」部分，按一下「Generate」。按一下「複製」即可複製密鑰，並妥善儲存。完整密鑰只會在生成後立即顯示。之後就會遮蓋。
- 選用：在「Secondary Secret」(次要密鑰) 區段中，按一下「Generate」(產生)。按一下「複製」即可複製密鑰，並妥善儲存。
- 在警告對話方塊中確認。新密鑰會立即生效，因此仍使用已取代密鑰的項目都會失敗。
輪替簽署密鑰
如果存在主要密鑰，系統會顯示「輪換密鑰」動作。 定期輪替密鑰是最佳的安全性做法。由於 Contact Center AI 平台會使用主要和次要密鑰簽署每項要求，因此您可以在不中斷傳送作業的情況下輪替密鑰：
- 在 CCAI Platform 入口網站中，依序點選「Settings」>「Developer Settings」。 如果沒有看到「設定」選單，請按一下「選單」圖示 。
- 請務必設定主要和次要密鑰。
- 按一下「輪換密鑰」，即可交換主要和次要密鑰。
- 更新應用程式，根據新的有效密鑰驗證簽章。 在重疊期間，Contact Center AI 平台會使用設定的兩個密鑰簽署每項要求，因此接受任一密鑰都不會中斷傳送。
儲存設定
選取「儲存」，套用已啟用狀態和網址。產生或輪替密鑰的操作會立即生效，不需要儲存。啟用 Webhook、設定 Webhook 網址和主要密鑰後，Contact Center AI 平台就會開始傳送事件。
應用程式收到的內容
啟用 Webhook 後，Contact Center AI Platform 會針對每個支援的即時通訊事件 (例如生命週期變更、參與者活動、訊息、轉移、升級、網路表單和解散警告)，傳送 HTTP POST 要求。每個要求主體都是 JSON 信封，內含 event_type、timestamp、chat_id 和事件專屬的 body。