Webhook
מחבר ה-Webhook מאפשר להאזין לאירועים מהקצה העורפי שתומך ב-Webhooks. המחבר הזה מיועד לשימוש עם הטריגר של Webhook. הטריגר Webhook מקבל אירועים מאפליקציות מבוססות SaaS של צד שלישי שתומכות ביכולת של אירועי webhook. הטריגר הזה תומך בכמה סוגי אימות עבור רכיב event listener. כדי להשתמש בטריגר Webhook בשילוב, צריך קודם להגדיר מחבר Webhook.
לפני שמתחילים
לפני שמשתמשים במחבר Webhook, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-Google Cloud:
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. המחבר וחשבון השירות צריכים להיות שייכים לאותו פרויקט. מידע נוסף זמין במאמר יצירת חשבון שירות.
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
- מפעילים את השירותים הבאים:
הגדרת המחבר
החיבור הוא ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- מחבר: בוחרים באפשרות Webhook מהרשימה הנפתחת של המחברים הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- שם החיבור: מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- במחברים שתומכים בהרשמה לאירועים, שמות החיבורים לא יכולים להתחיל בקידומת goog.
- תיאור: אפשר להזין תיאור למופע החיבור.
- חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- מינוי לאירועים: מינוי לאירועים יופעל כברירת מחדל והוא חובה למחבר של webhook.
- אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
-
בקטע פרטי מינוי לאירועים, ממלאים את הפרטים הבאים:
- אימות רכיב event listener: בוחרים סוג אימות לרכיב event listener של האירועים ומזינים את הפרטים הרלוונטיים.
המאזין ל-webhook תומך בסוגי האימות הבאים:
- ללא אימות
- אימות Google: מוודאים שלחשבון השירות יש את התפקיד roles/connectors.listener שאסימון הגישה שלו משמש לאימות.
- אימות באמצעות מפתח API
- אימות בסיסי
- מיקום השדה של סוג האירוע: שדה חובה שמציין את המיקום (כותרת, פרמטר של שאילתה או גוף הבקשה) שבו יופיע סוג האירוע שמשויך לבקשת האירוע הנכנסת.
- שם השדה של סוג האירוע: שדה חובה במיקום שהוגדר, שמזהה את סוג האירוע שמשויך לבקשת האירוע הנכנסת.
- בוחרים באפשרות הפעלת קישוריות פרטית כדי ליצור קישוריות מאובטחת בין אפליקציית הקצה העורפי לבין החיבור. אם בוחרים באפשרות הזו, צריך לבצע שלבי הגדרה נוספים אחרי יצירת הקישור. מידע נוסף זמין במאמר בנושא קישוריות פרטית למינוי לאירועים.
- מזינים את ההגדרה של תור ההודעות המתות. אם מגדירים תיבת דואר להודעות שלא נמסרו, החיבור כותב את האירועים שלא עברו עיבוד אל נושא Pub/Sub שצוין. ממלאים את הפרטים הבאים:
- מזהה פרויקט של הודעות שלא ניתן למסור: מזהה הפרויקט ב-Google Cloud שבו הגדרתם את נושא ה-Pub/Sub של הודעות שלא ניתן למסור.
- נושא להודעות ללא מוצא: נושא Pub/Sub שבו רוצים לכתוב את הפרטים של האירוע שלא עבר עיבוד.
- לוחצים על הבא.
בדוגמה שלמעלה, השדה event_type בגוף הבקשה מציין שהבקשה מתייחסת לאירוע user.created.{ "event_type": "user.created", ... // other request fields ... }
- אימות רכיב event listener: בוחרים סוג אימות לרכיב event listener של האירועים ומזינים את הפרטים הרלוונטיים.
- בדיקה: בודקים את פרטי החיבור והאימות של המאזין.
- לוחצים על יצירה.
שימוש בחיבור Webhook בשילוב
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.