הפעלה של webhook

הטריגר של Webhook הוא טריגר של אירוע מחבר שמאפשר להפעיל שילוב על סמך אירועים מהקצה העורפי שתומך ב-Webhooks. הטריגר Webhook מקבל אירועים מאפליקציות מבוססות SaaS של צד שלישי שתומכות ביכולת של אירועי webhook. הטריגר הזה תומך בכמה סוגי אימות עבור רכיב event listener ומקבל רק מטען ייעודי (payload) מסוג JSON.

לפני שמתחילים

אם אתם מתכננים ליצור או להגדיר חיבור חדש לטריגר של Webhook, ודאו שיש לכם את התפקיד הבא בממשק לניהול זהויות והרשאות גישה (IAM) בפרויקט:

  • אדמין של מחבר (roles/connectors.admin)

    • מידע על הקצאת תפקידים מופיע במאמר ניהול הגישה.

מקצים לחשבון השירות שרוצים להשתמש בו עבור הפעלת ה-Webhook את תפקידי ה-IAM הבאים:

הוספת טריגר מסוג Webhook

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

  1. נכנסים לדף Application Integration במסוף Google Cloud .

    מעבר אל Application Integration

  2. בתפריט הניווט, לוחצים על Integrations (שילובים).

    מוצגת רשימה של כל השילובים שזמינים בפרויקט Google Cloud בדף Integrations List.

  3. בוחרים שילוב קיים או לוחצים על יצירת שילוב כדי ליצור שילוב חדש.

    אם יוצרים שילוב חדש:

    1. מזינים שם ותיאור בחלונית יצירת שילוב.
    2. בוחרים אזור לשילוב.
    3. בוחרים חשבון שירות לאינטגרציה. אפשר לשנות או לעדכן את פרטי חשבון השירות של שילוב בכל שלב מחלונית סיכום השילוב בסרגל הכלים של השילוב.
    4. לוחצים על יצירה.

    השילוב החדש שנוצר ייפתח בכלי השילובים.

  4. בסרגל הניווט של כלי העריכה של השילוב, לוחצים על טריגרים כדי לראות את רשימת הטריגרים הזמינים.
  5. לוחצים על הרכיב Webhook trigger (טריגר של webhook) וממקמים אותו בכלי לעריכת שילובים.

    6. כדי להגדיר את הטריגר של ה-Webhook, אפשר להשתמש בחיבור Webhook קיים שזמין ב-Integration Connectors, או ליצור חיבור Webhook חדש באמצעות האפשרות ליצירת חיבור מוטבע.

הגדרת טריגר של Webhook באמצעות חיבור קיים

אפשר להגדיר את הטריגר של ה-Webhook באמצעות חיבור Webhook קיים ב-Integration Connectors. שימו לב: הטריגר Webhook הוא טריגר של אירוע מחבר, ולכן אפשר להשתמש בחיבור Webhook רק אם מופעלת הרשמה לאירועים כדי להגדיר את הטריגר.

מידע על הגדרת טריגר מסוג Webhook באמצעות חיבור Webhook חדש זמין במאמר הגדרת טריגר מסוג Webhook באמצעות חיבור חדש

כדי להגדיר טריגר של Webhook באמצעות חיבור Webhook קיים, מבצעים את השלבים הבאים:

  1. לוחצים על הרכיב Webhook trigger (טריגר של webhook) בכלי לעריכת שילובים כדי לפתוח את חלונית הגדרת הטריגר.
  2. לוחצים על Configure trigger (הגדרת הטריגר).
  3. בדף Connector Event Trigger Editor (עורך טריגרים של אירועים של מחבר), מזינים את פרטי ההגדרה הבאים:
    1. אזור: בוחרים את האזור של חיבור ה-Webhook.
    2. חיבור: בוחרים את חיבור ה-Webhook שרוצים להשתמש בו.

      ב-Application Integration מוצגים רק חיבורי Webhook פעילים שמופעל בהם מינוי לאירועים.

    3. סוג המינוי לאירוע: מזינים את סוג האירוע שרוצים להשתמש בו כדי להפעיל את השילוב.
    4. חשבון שירות: בוחרים חשבון שירות עם תפקידי ה-IAM הנדרשים להפעלת ה-Webhook.
  4. לוחצים על סיום כדי להשלים את הגדרת הטריגר ולסגור את הדף.
מידע נוסף זמין במאמר בנושא חיבור Webhook.

הגדרת טריגר מסוג Webhook באמצעות חיבור חדש

כדי להגדיר את הטריגר של ה-Webhook באמצעות חיבור חדש של Webhook, מבצעים את השלבים הבאים:

  1. לוחצים על הרכיב Webhook trigger (טריגר של webhook) בכלי לעריכת שילובים כדי לפתוח את חלונית הגדרת הטריגר.
  2. לוחצים על Configure trigger (הגדרת הטריגר).
  3. מדלגים על השדה אזור.
  4. לוחצים על Connection (חיבור) ובוחרים באפשרות Create Connection (יצירת חיבור) מהתפריט.
  5. מבצעים את השלבים הבאים בחלונית Create Connection (יצירת חיבור):
    1. בקטע מיקום, בוחרים את המיקום של החיבור.
      1. אזור: בוחרים מיקום מהרשימה.

        אזורים נתמכים למחברים:

        רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.

      2. לוחצים על הבא.
    2. בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
      1. מחבר: בוחרים באפשרות Webhook מהרשימה הנפתחת של המחברים הזמינים.
      2. גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
      3. שם החיבור: מזינים שם למופע החיבור.

        השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:

        • שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
        • האותיות צריכות להיות קטנות.
        • שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
        • שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
        • במחברים שתומכים בהרשמה לאירועים, שמות החיבורים לא יכולים להתחיל בקידומת goog.
      4. תיאור: אפשר להזין תיאור למופע החיבור.
      5. חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
      6. מינוי לאירועים: מינוי לאירועים יופעל כברירת מחדל והוא חובה למחבר של webhook.
      7. אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
      8. לוחצים על הבא.
    3. בקטע פרטי מינוי לאירועים, ממלאים את הפרטים הבאים:
      1. אימות רכיב event listener: בוחרים סוג אימות לרכיב event listener של האירועים ומזינים את הפרטים הרלוונטיים.

        המאזין ל-webhook תומך בסוגי האימות הבאים:

      2. מיקום השדה של סוג האירוע: שדה חובה שמציין את המיקום (כותרת, פרמטר של שאילתה או גוף הבקשה) שבו יופיע סוג האירוע שמשויך לבקשת האירוע הנכנסת.
      3. שם השדה של סוג האירוע: שדה חובה במיקום שהוגדר, שמזהה את סוג האירוע שמשויך לבקשת האירוע הנכנסת.
        4. ‫
        {
"event_type": "user.created",
...
// other request fields
...
}
         בדוגמה שלמעלה, השדה event_type בגוף הבקשה מציין שהבקשה מתייחסת לאירוע user.created.
      4. בוחרים באפשרות הפעלת קישוריות פרטית כדי ליצור קישוריות מאובטחת בין אפליקציית הקצה העורפי לבין החיבור. אם בוחרים באפשרות הזו, צריך לבצע שלבי הגדרה נוספים אחרי יצירת הקישור. מידע נוסף זמין במאמר בנושא קישוריות פרטית למינוי לאירועים.
      5. מזינים את ההגדרה של תור ההודעות המתות. אם מגדירים תיבת דואר להודעות שלא נמסרו, החיבור כותב את האירועים שלא עברו עיבוד אל נושא Pub/Sub שצוין. ממלאים את הפרטים הבאים:
        1. מזהה פרויקט של הודעות שלא ניתן למסור: מזהה הפרויקט ב-Google Cloud שבו הגדרתם את נושא ה-Pub/Sub של הודעות שלא ניתן למסור.
        2. נושא להודעות ללא מוצא: נושא Pub/Sub שבו רוצים לכתוב את הפרטים של האירוע שלא עבר עיבוד.
      6. לוחצים על הבא.
    4. בדיקה: בודקים את פרטי החיבור והאימות של המאזין.
    5. לוחצים על יצירה.

פלט של טריגר

תהליך ההגדרה של מינוי לאירועים באמצעות Webhook trigger נמשך כמה דקות. אפשר לראות את הסטטוס של המינוי לאירוע בחלונית ההגדרה של הטריגר, בקטע פרטי המינוי לאירוע.

הטריגר של ה-Webhook מציין את הסטטוס של מינוי לאירוע באמצעות המצבים הבאים:

  • ‫Creating: מציין שהטריגר נרשם למינוי האירוע.
  • ‫Active: מציין שהטריגר נרשם בהצלחה למינוי לאירוע.
  • ‫Error: מציין שיש בעיה במינוי לאירועים שהוגדר.

בנוסף לסטטוס המינוי לאירוע, בקטע Event Subscription details (פרטי המינוי לאירוע) מוצגים גם פרטים אחרים כמו אזור החיבור, שם החיבור, שם המינוי לאירוע ועוד.

משתנה הפלט של הטריגר

לכל אירוע, הטריגר של ה-Webhook יוצר משתנה פלט ConnectorEventPayload שאפשר להשתמש בו במשימות בהמשך. משתנה הפלט הוא בפורמט JSON ומכיל את סכימת מטען ה-Webhook של הפלט. הטריגר Webhook מקבל רק מטען ייעודי (payload) בפורמט JSON.

הצגת מינויים לאירועים

כדי לראות ולנהל את כל המינויים לאירועים שמשויכים לחיבור ב-Integration Connectors, פועלים לפי השלבים הבאים:

  1. עוברים לדף Integration Connectors > Connections.

    כניסה לדף Connections

  2. לוחצים על החיבור שרוצים לראות את המינויים שלו.
  3. לוחצים על הכרטיסייה מינויים לאירועים.

    כאן מוצגים כל המינויים לאירועים של החיבור.

עריכת טריגר של webhook

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

כדי לערוך טריגר של Webhook:

  1. לוחצים על הרכיב Webhook trigger (טריגר של webhook) בכלי לעריכת שילובים כדי לפתוח את חלונית הגדרת הטריגר.
  2. לוחצים על Configure Webhook trigger (הגדרת טריגר של Webhook).
  3. בדף Connector Event Trigger Editor (עורך טריגרים של אירועים במחבר), מבצעים את הפעולות הבאות:
    1. כדי לשמור את המינוי הקודם לאירועים, לוחצים על שמירה. אחרת, לוחצים על מחיקה.
    2. מעדכנים את הגדרות החיבור ואת פרטי המינוי לאירועים לפי הצורך.
    3. לוחצים על סיום.

    4. אפשר לראות את פרטי החיבור וההרשמה לאירועים המעודכנים בחלונית ההגדרות של הטריגר, בקטע פרטי הרשמה לאירועים.

מכסות ומגבלות

מידע על מכסות ומגבלות זמין במאמר מכסות ומגבלות.

המאמרים הבאים