באמצעות תגובות לפעולות מאתר אחר (webhook), ה-API של אפליקציות שולח לאפליקציה שלכם התראה בזמן אמת בכל פעם שמתרחש אירוע רלוונטי במהלך סשן צ'אט – למשל, כשנוצר צ'אט, כשמתקבלת הודעה או כשצ'אט מועבר או מועלה לרמה גבוהה יותר. אפשר להשתמש ב-Webhooks כדי להגיב לפעילות בצ'אט בזמן שהיא מתרחשת, במקום להשתמש ב-API.
ההיקף של ה-Webhooks הוא סשנים של צ'אט ב-API של האפליקציות. פלטפורמת Contact Center AI שולחת את כל אירועי ה-webhook של הצ'אט ב-API של האפליקציות הנתמכות כבקשות HTTP POST לכתובת webhook אחת שאתם מגדירים. אין מינוי לכל אירוע.
לפני שמתחילים
- כדי להגדיר וווב-הוקים, צריך להיות אדמין (או לקבל תפקיד עם הרשאה לערוך את הגדרות הפיתוח).
- מכינים נקודת קצה שיכולה לקבל בקשות HTTP מסוג
POST. כתובת ה-URL של ה-webhook חייבת להשתמש ב-HTTPS.
הפעלת webhooks
כשמפעילים את ה-webhook, פלטפורמת Contact Center AI שולחת אירועי webhook לכתובת ה-URL שהגדרתם, והשדות URL ו-secret מופיעים. כשהאפשרות 'ווּבְהוּקים' מושבתת, לא נשלחים אירועים.
כדי להפעיל את ה-webhook, פועלים לפי השלבים הבאים:
- בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.
- עוברים לחלונית Webhooks (ווּבְהוּקים) ולוחצים על המתג Webhooks (ווּבְהוּקים) כדי להעביר אותו למצב מופעל.
הגדרת כתובת ה-URL של ה-webhook
- בקטע URL, מזינים את נקודת הקצה של ה-webhook.
- מוודאים שנקודת הקצה משתמשת ב-HTTPS ויכולה לקבל בקשות
POST. פלטפורמת Contact Center AI שולחת את כל האירועים הנתמכים לכתובת ה-URL היחידה הזו.
יצירת סודות לחתימה
פלטפורמת Contact Center AI חותמת כל בקשת webhook, כדי שהאפליקציה תוכל לוודא שהבקשה הגיעה מפלטפורמת Contact Center AI. הוא שולח את החתימה בכותרת הבקשה X-Signature ואת חותמת הזמן של החתימה ב-X-Signature-Timestamp.
אפשר להגדיר עד שני ערכי Secret לחתימה:
- סוד ראשי: האסימון הראשי שמשמש לחתימה על בקשות webhook.
- סוד משני: טוקן שני אופציונלי. כשמגדירים API Secret משני, Contact Center AI Platform חותמת על כל בקשה עם שני ערכי ה-API Secret, וכך אפשר להחליף את ערכי ה-API Secret בלי לפספס אירועים.
יוצרים כל סוד בנפרד. כדי ליצור סוד, פועלים לפי השלבים הבאים:
- בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.
- עוברים לחלונית Webhooks.
- בקטע Primary Secret (סוד ראשי), לוחצים על Generate (יצירה). לוחצים על Copy כדי להעתיק סוד ולאחסן אותו באופן מאובטח. הסוד המלא מוצג רק מיד אחרי שיוצרים אותו. אחרי כן, הוא מוסתר.
- אופציונלי: בקטע Secondary Secret (סוד משני), לוחצים על Generate (יצירה). לוחצים על העתקה כדי להעתיק סוד ולאחסן אותו בצורה מאובטחת.
- מאשרים בתיבת הדו-שיח של האזהרה. הסוד החדש נכנס לתוקף באופן מיידי, כך שכל דבר שעדיין משתמש בסוד שהוחלף ייכשל.
החלפת סודות החתימה
כשקיים סוד ראשי, הפעולה Rotate Secrets (החלפת סודות) הופכת לזמינה. רוטציה של סודות באופן תקופתי היא שיטה מומלצת לשמירה על האבטחה. מכיוון ש-Contact Center AI Platform חותם כל בקשה גם באמצעות הסוד הראשי וגם באמצעות הסוד המשני, אפשר לבצע רוטציה בלי להפריע למסירה:
- בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.
- חשוב לוודא שהוגדר סוד ראשי וסוד משני.
- לוחצים על החלפת סודות כדי להחליף בין הסוד הראשי לסוד המשני.
- מעדכנים את האפליקציה כדי לאמת חתימות מול הסוד הפעיל החדש. במהלך החפיפה, Contact Center AI Platform חותם על כל בקשה עם שני הסודות שהוגדרו, כך שאפשר לקבל כל אחד מהם והמסירה לא מופרעת.
שמירת ההגדרה
לוחצים על שמירה כדי להחיל את כתובת ה-URL ואת המצב המופעל של ה-webhook. יצירה או החלפה של סוד נכנסות לתוקף באופן מיידי ולא דורשות פעולת שמירה. פלטפורמת Contact Center AI מתחילה לספק אירועים אחרי שמפעילים את התגובות לפעולות מאתר אחר (webhook) ומגדירים webhook URL וסוד ראשי.
מה האפליקציה מקבלת
אחרי שמפעילים את ה-webhook, פלטפורמת Contact Center AI שולחת בקשת HTTP POST לכל אירוע נתמך בצ'אט, כמו שינויים במחזור החיים, פעילות של משתתפים, הודעות, העברות, פניות ישירות, טפסים באינטרנט ואזהרות על סגירת הצ'אט. כל תוכן בקשה הוא מעטפת JSON עם event_type, timestamp, chat_id ו-body ספציפי לאירוע.