ווּבּהוּקים לפלטפורמת ה-API של הצ'אט

‫Webhooks מאפשרים לאפליקציות חיצוניות לקבל התראות בזמן אמת כשמתרחשים אירועים מסוימים בפלטפורמה.

כדי להשתמש בתגובות לפעולות מאתר אחר (webhook), צריך להפעיל אותן וליצור אסימונים. שימוש בשני סודות נפרדים לכתובת URL אחת של webhook מוסיף שכבת אבטחה נוספת. אם סוד אחד נחשף או שצריך להחליף אותו מסיבה כלשהי, אפשר לעדכן ולהחליף את הסודות בלי להפריע לשירות ה-webhook או לסכן את אבטחת הנתונים.

הפעלת webhooks

כדי להפעיל את ה-webhook, פועלים לפי השלבים הבאים:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.

  2. עוברים לחלונית Webhooks (ווּבְהוּקים) ולוחצים על המתג Webhooks (ווּבְהוּקים) כדי להעביר אותו למצב מופעל.

  3. בקטע URL, מזינים כתובת URL של webhook. כתובת ה-URL הזו היא נקודת הקצה שמקבלת התראות בזמן אמת. חשוב לוודא ש-webhook יכול לקבל בקשות HTTP.

  4. לוחצים על יצירה. המערכת יוצרת את הסוד הראשי, שהוא טוקן האבטחה העיקרי שמשמש לאימות ולבדיקה של מטען ייעודי (payload) של webhook נכנס. הוא משמש כאמצעי העיקרי לאבטחת התקשורת של ה-webhook.

  5. מעתיקים את האסימון ושומרים אותו במקום מאובטח.

  6. יצירת סוד משני. הסוד המשני משמש כאסימון אבטחה לגיבוי או למעבר לגיבוי במקרה של כשל. הוא מסופק כאמצעי אבטחה נוסף כדי לשפר את האמינות והזמינות של התראות ה-webhook. אם מסיבה כלשהי הסוד הראשי נפרץ או שיש בעיות בשימוש בו, הסוד המשני יכול להשתלט ולהמשיך להבטיח את התקשורת.

  7. מעתיקים את האסימון ושומרים אותו במקום מאובטח.

  8. לוחצים על Save.

רוטציה של סודות

מומלץ לבצע רוטציה של סודות של Webhook באופן תקופתי. התהליך הזה כולל יצירה של מפתחות סודיים חדשים עבור ה-webhook הראשי והמשני, ועדכון שלהם באפליקציה כדי להמשיך לקבל התראות בצורה חלקה.

אחרי ההגדרה הראשונית של ה-webhook, אי אפשר ליצור סוד ראשי חדש באופן ישיר, אבל אפשר ליצור סוד משני חדש ולבצע רוטציה של הסודות כדי לשנות אותם.

כדי להחליף סודות, מבצעים את השלבים הבאים:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.

  2. לוחצים על Rotate Secrets (החלפת סודות).

  3. לוחצים על Save.

יצירת סודות חדשים

כדי להחליף את הסודות כך שיהיו לכם שני מפתחות סודיים חדשים, פועלים לפי השלבים הבאים:

  1. בפורטל של CCAI Platform, לוחצים על הגדרות > הגדרות למפתחים. אם תפריט ההגדרות לא מופיע, לוחצים על תפריט.

  2. לוחצים על יצירה כדי ליצור סוד משני חדש.

  3. לוחצים על החלפת סודות כדי להפוך את הסוד המשני החדש לסוד הראשי.

  4. לוחצים על יצירה כדי ליצור סוד משני חדש שיחליף את הסוד הראשי הישן.

  5. לוחצים על Save.