תיעוד Nodaroפלט Webhook
שלחו תוצאות של תהליך לכל כתובת בבקשת HTTP POST עם גוף JSON, עם ערכים בשמות שתבחרו ועם פרטי גישה שמורים לפי הצורך, שהסוד שלהם נשאר בשרת.
רכיב פלט Webhook שולח את התוצאות של התהליך שלכם לכתובת URL בבקשת HTTP POST עם גוף JSON. השתמשו בו כדי להעביר סרטון, תמונה, קובץ אודיו או טקסט גמורים לשרת שלכם, למערכת ניהול תוכן או לשירות אוטומציה. אתם בוחרים את השמות של הערכים שהרכיב שולח, והוא יכול לשלוח מפתח שמור עם כל בקשה, בלי להציג את המפתח בתהליך אף פעם.
מתי להשתמש
- לשלוח למערכת ניהול תוכן את כתובת ה-URL של סרטון שנוצר, ברגע שהסרטון מוכן.
- להתחיל אוטומציה בשירות אחר כשתהליך מסתיים.
- להעביר תוצאות ל-API שלכם לעיבוד נוסף.
- להודיע למערכת אחרת שהרצה מתוזמנת, או הרצה שטריגר התחיל, הסתיימה.
התחלה מהירה
הוספת הרכיב
הקישו Tab על הקנבס ובחרו פרסום › ייצוא › פלט Webhook.
הקלדת הכתובת
בחלונית ההגדרות, הקלידו את הכתובת בשדה כתובת Webhook, למשל https://example.com/webhook. השתמשו בכתובת https://.
מתן שמות לערכים שנשלחים
תחת פרמטרים של קלט, לחצו על הוספה לכל ערך, הקלידו את השם שלו, כגון video_url, ובחרו את הסוג שלו. כל פרמטר מוסיף לרכיב קלט באותו שם.
חיבור והרצה
חברו כל קלט לרכיב שמפיק את הערך שלו, ולחצו על הרצה. החלונית מציגה תחת שליחה אחרונה את קוד הסטטוס של HTTP שהמסירה החזירה.
קלטים
הקלטים תלויים בפרמטרים שאתם מגדירים.
- בלי פרמטרים. לרכיב יש קלט אחד. כל מה שמחובר אליו נשלח כמטען אחד.
- פרמטר אחד או יותר. לרכיב יש קלט אחד לכל פרמטר, בשם של הפרמטר. כל ערך נשלח תחת השם של הפרמטר שלו.
שליחה פעם אחת לכל פריט
כשרשימה מגיעה לקלט דרך חיבור במצב כל אחד, הרכיב שולח בקשה אחת לכל פריט. למשל, כשרכיב סינון רשימה מעביר רשימה של כתבות, נשלחת בקשה אחת לכל כתבה. רשימה שנייה בפרמטר אחר מוצמדת לפי שורה: פריט 3 נשלח עם פריט 3. רשימה קצרה יותר מתחילה שוב מהפריט הראשון שלה. פריט ריק לא מוסיף לבקשה שום ערך לפרמטר הזה.
כשאף אחד מהחיבורים לרכיב לא העביר שום דבר בהרצה הזו, הרכיב לא שולח כלום ומציג דולג · אין קלט. זה קורה, למשל, כשרכיב סינון רשימה לא השאיר אף פריט. שום בקשה ריקה לא מגיעה לנקודת הקצה שלכם, וההרצה בכל זאת מסתיימת.
פלטים
הפלט תגובה מעביר את מה שהמסירה החזירה, כך שאפשר להריץ רכיב נוסף אחריו. בהרצה מהעורך, הפלט הוא גוף התגובה. בהרצה בשרת, כמו הרצה שטריגר התחיל או הרצה מתוזמנת, הפלט הוא המילה sent.
הגדרות
| הגדרה | מה היא עושה |
|---|---|
| כתובת Webhook | הכתובת שמקבלת את בקשת ה-POST. |
| מפתח גישה | מפתח שמור שנשלח ככותרת עם כל בקשה. ברירת המחדל היא ללא — לשלוח בלי מפתח. ראו את הסעיף שליחה עם פרטי גישה. |
| פרמטרים של קלט | הערכים שנשלחים, כל אחד תחת השם שלו. לכל ערך יש שם וסוג: טקסט, כתובת תמונה, כתובת וידאו או כתובת אודיו. |
| שליחה אחרונה | קוד הסטטוס של HTTP של המסירה האחרונה, או עוד לא נשלח. |
איך הבקשה נראית
הרכיב שולח בקשת POST עם גוף JSON. עם שני פרמטרים בשמות video_url ו-caption, הגוף נראה כך:
{
"video_url": "https://cdn.example.com/results/clip.mp4",
"caption": "Our new product, in 15 seconds."
}ערכי מדיה הם כתובות ה-URL של הקבצים, והשירות המקבל יכול להוריד אותם.
שליחה עם פרטי גישה
שירותים רבים מקבלים מסירה רק עם מפתח בכותרת, כגון Authorization: Bearer .... שמרו את המפתח פעם אחת כפרטי גישה, ואז בחרו את פרטי הגישה ברכיב.
שמירת המפתח
פתחו את אינטגרציות › מפתחות גישה ל-Webhook ושמרו פרטי גישה חדשים, עם שם של כותרת, למשל Authorization, ועם הערך הסודי שלה. הקישור ניהול מפתחות בחלונית ההגדרות פותח את אותו דף.
מי יכול להשתמש במפתח
הדף אינטגרציות שואל מי יכול להשתמש במפתח. בחרו באפשרות כל כתובת או רק כתובת אחת. ההבדל מוסבר בהמשך.
בחירת פרטי הגישה ברכיב
בתפריט מפתח גישה של הרכיב, בחרו את פרטי הגישה ששמרתם. מעכשיו כל מסירה מהרכיב הזה כוללת את הכותרת.
הרכיב שומר רק מזהה שמצביע על פרטי הגישה. הסוד מפוענח בשרת כשהבקשה נשלחת, ולא מוצג שוב אף פעם. הוא אף פעם לא נכנס לתהליך, לייצוא, לתבנית או לערכה. כדי להחליף מפתח, שמרו ערך חדש במקום הישן.
כל כתובת או רק כתובת אחת
| בחירה | איפה זה עובד | מתי להשתמש בה |
|---|---|---|
| כל כתובת | רק בהרצות שאתם מתחילים בעצמכם: הרצה מהעורך ותזמון שהגדרתם בעורך. | אתם עדיין בונים את התהליך. |
| רק כתובת אחת | בכל הרצה, כולל אפליקציות שפורסמו, תהליכים משותפים והרצות שטריגר התחיל, אבל רק כשהרכיב שולח לכתובת הנעולה. | התהליך רץ בלעדיכם, או שאנשים אחרים מריצים אותו. |
פרטי גישה שלא ננעלו נדחים באפליקציה שפורסמה, בתהליך משותף, בהרצה של שותף, בהרצה שהתחילה עם אסימון API, בטריגר Webhook ובתזמון שנוצר דרך ה-API. הרכיב נכשל אז עם הודעה ברורה, במקום לשלוח בלי המפתח.
פרטי גישה נעולים קשורים לכתובת https:// אחת. כברירת מחדל, הנעילה היא לכתובת המדויקת הזו. הפעילו את המתג לאפשר גם נתיבים מתחת לכתובת הזו כדי להשתמש במפתח אחד לכמה כתובות של אותו שירות. כשבוחרים פרטי גישה שנעולים לכתובת מדויקת, השדה כתובת Webhook נקבע לפיהם ואי אפשר לערוך אותו.
הנעילה היא חד־כיוונית. אפשר לשנות את הכתובת הנעולה בהמשך, אבל אי אפשר להסיר אותה.
פרסום ושיתוף דורשים פרטי גישה נעולים
לפני שמפרסמים תהליך כאפליקציה או משתפים אותו כדי שאחרים יריצו אותו, כל פרטי הגישה שהוא שולח איתם חייבים להיות נעולים לכתובת שהרכיב שולח אליה, כולל פרטי גישה בתת־תהליכים. תיבות הדו־שיח של הפרסום והשיתוף מציעות לנעול פרטי גישה לכתובת הנוכחית של הרכיב בלחיצה אחת.
מה הנעילה אוכפת
בכל בקשה, ובכל הפניה:
- הכתובת חייבת להתאים לכתובת הנעולה. אחרת, הבקשה נדחית לפני שהיא יוצאת.
- הרכיב לא עוקב אחרי הפניה לשום כתובת אחרת. הבקשה נכשלת, במקום להמשיך בלי המפתח.
- בהפניה לאתר אחר, הבקשה נשלחת בלי פרטי גישה שלא ננעלו.
- פרטי גישה אף פעם לא נשלחים על גבי
http://רגיל.
תגובות מוסתרות כשמצורף מפתח
כשמצורפים פרטי גישה, גוף התגובה לא מוחזר, לא נשמר ולא מוצג. מוחזר רק קוד הסטטוס. יש שירותים שחוזרים בתגובה שלהם על כותרות הבקשה, ואסור שהמפתח יחזור לתהליך.
פרטי גישה שנמחקו, או ששייכים לחשבון אחר, גורמים לכשל ברכיב. הרכיב אף פעם לא שולח בקשה בלי המפתח שלו.
תהליכים מיוצאים
בייצוא של תהליך או בתבנית אף פעם אין פרטי גישה. כשמישהו מייבא את התהליך, רכיב פלט Webhook מגיע בלי פרטי גישה, ומי שמייבא בוחר את שלו. ניהול פרטי הגישה נעשה רק באפליקציה של Nodaro.
טיפים
- בדקו קודם את הכתובת. בזמן הבנייה, הגדירו ברכיב כתובת של שירות לבדיקת בקשות, ובדקו את הגוף לפני שאתם עוברים לנקודת הקצה האמיתית שלכם.
- השתמשו בשמות של הצד המקבל. תנו לפרמטרים בדיוק את השמות שהשירות המקבל מצפה להם.
- התחילו הרצות מבחוץ. שלבו את רכיב פלט Webhook עם רכיב טריגר Webhook או רכיב טריגר מתוזמן, לתהליך שרץ בלי שאף אחד נמצא בעורך.
- שמרו עותק. חברו את אותה תוצאה גם לרכיב שמירה לאחסון.
פתרון בעיות
הרכיב נכשל אחרי הבקשה. הכתובת המקבלת ענתה בשגיאה. קוד הסטטוס מופיע תחת שליחה אחרונה, והשגיאה מופיעה בהיסטוריית ההרצות.
הבקשה נדחית לפני שהיא נשלחת. בדקו את הכתובת. כתובת URL שמפנה לכתובת ברשת פרטית או מקומית נדחית. כשמצורפים פרטי גישה, הכתובת צריכה גם להתאים לכתובת שאליה פרטי הגישה נעולים.
החלונית מזהירה שהכתובת היא לא הכתובת הנעולה. פרטי הגישה נעולים לכתובת אחרת, למשל אחרי ייבוא. לחצו על שימוש בכתובת הנעולה, או בחרו פרטי גישה אחרים.
הרכיב עובד כשאתם מריצים אותו, אבל נכשל באפליקציה שפורסמה או בהרצה שטריגר התחיל. פרטי הגישה לא נעולים לכתובת. נעלו אותם לכתובת של הרכיב בדף אינטגרציות, ואז הריצו שוב.
שאלות נפוצות
מה רכיב פלט Webhook שולח?
רכיב פלט Webhook שולח בקשת HTTP POST עם גוף JSON. כשמוגדרים פרמטרים, השם של כל פרמטר הוא מפתח ב-JSON, והערך מהרכיב המחובר הוא הערך שלו, למשל כתובת URL של סרטון. בלי פרמטרים, כל הנתונים המחוברים נשלחים כמטען אחד.
איך שולחים מפתח API או אסימון עם ה-Webhook?
שמרו את המפתח פעם אחת כפרטי גישה בדף אינטגרציות, עם שם של כותרת כגון Authorization ועם הערך הסודי שלה. אחר כך בחרו את פרטי הגישה בתפריט מפתח גישה של רכיב פלט Webhook. הסוד נשאר בשרת ואף פעם לא נכלל בתהליך.
למה פרטי הגישה שלי נדחים באפליקציה שפורסמה או בתהליך משותף?
ברכיב פלט Webhook, פרטי גישה שלא ננעלו לכתובת עובדים רק בהרצות שאתם מתחילים בעצמכם. כשנועלים אותם לכתובת שאליה הרכיב שולח, הם עובדים גם באפליקציות שפורסמו, בתהליכים משותפים ובהרצות שטריגר התחיל.
למה אני לא רואה את התגובה מהשרת?
כשמצורפים פרטי גישה לרכיב פלט Webhook, Nodaro לא מחזיר, לא שומר ולא מציג את התגובה, רק את קוד הסטטוס שלה, כי יש שרתים שחוזרים בתגובה על כותרות הבקשה, כולל המפתח.
האם רכיב פלט Webhook עולה קרדיטים?
לא. שליחת Webhook לא עולה כלום. משלמים רק על הרכיבים שיצרו את התוצאות.
דפים קשורים
רכיבי פרסום
טריגר Webhook
שמירה לאחסון
אוטומציות
ה-API של Webhooks
עודכן לאחרונה