כל בקשת webhook מספרת לך מה קרה בסביבת העבודה שלך או באחד ממרכזי העזרה שלה. מאמר זה מפרט כל אירוע שתוכל לבחור עבור נקודת קצה, כיצד נראית כל בקשה ומה היא מכילה.
POSTideventversionoccurred_atsite_iddataאירועים שתוכלו לבחור
לוח המחוונים מקבץ אירועים באותו אופן כמו הטבלאות למטה. העמודה הראשונה היא השם שאתה רואה בבורר האירועים. השנייה היא שם האירוע שהשרת שלך מקבל ב-event.
אנשי קשר
| בלוח המחוונים | מִקרֶה | נשלח מתי |
|---|---|---|
| הודעת יצירת קשר התקבלה | מבקר שולח את טופס יצירת הקשר שלך | contact_message.created |
תוֹכֶן
| בלוח המחוונים | מִקרֶה | נשלח מתי |
|---|---|---|
| המאמר נוצר | נוסף מאמר חדש, או שפה חדשה של מאמר | article.created |
| המאמר עודכן | תוכן המאמר משתנה במהלך סנכרון | article.updated |
| מאמר שפורסם | פורסם לשון של מאמר | article.published |
| המאמר לא פורסם | לשון שפורסמה של מאמר אינה עוד מתפרסמת | article.unpublished |
| המאמר נמחק | מאמר נמחק | article.deleted |
| מאמר מתורגם | מאמר מתורגם אוטומטית לשפה חדשה | article.translated |
| התגובה נוספה | קורא מגיב לכתבה | article.reaction.added |
| התגובה השתנתה | קורא משנה את תגובתו | article.reaction.changed |
| התגובה הוסרה | קורא מסיר את תגובתו | article.reaction.removed |
| משוב על המאמר שהתקבל | קורא שולח משוב בכתב על מאמר | article.feedback.created |
| קטגוריה נוצרה | קטגוריה חדשה, או שפה חדשה של קטגוריה, מתווספת | category.created |
| הקטגוריה עודכנה | תוכן הקטגוריה משתנה במהלך סנכרון | category.updated |
| הקטגוריה נמחקה | קטגוריה נמחקת | category.deleted |
| פורסם ערך יומן השינויים | מאמר בקטגוריית יומן שינויים פורסם | changelog.published |
| הסנכרון הושלם | הסנכרון עם Notion מסתיים | sync.completed |
| הסנכרון נכשל | סנכרון עם Notion נכשל | sync.failed |
article.updated ו-category.updated לא נשלחים כאשר רק הסטטוס או מאפיינים אחרים משתנים. אירועי קטגוריה נשלחים פעם אחת לכל שפה.
תגובות ומשוב למאמרים מוגבלים ל-120 אירועים בדקה עבור כל מרכז עזרה. אירועים מעבר למגבלה אינם נשלחים, לכן השתמשו בניתוח הנתונים של מרכז העזרה שלכם לקבלת סיכומים.
הגדרות מרכז העזרה
| בלוח המחוונים | מִקרֶה | נשלח מתי |
|---|---|---|
| הגדרות מרכז העזרה נשמרו | הגדרה של מרכז העזרה נשמרה | site.updated |
| קוד מותאם אישית נשמר | CSS או JavaScript מותאמים אישית נשמרים | site.custom_code.updated |
| דומיין מותאם אישית אומת | הדומיין המותאם אישית שלך מתחיל להגיש את שירות מרכז העזרה | site.domain.verified |
| בדיקת הדומיין המותאם אישית נכשלה | לא ניתן היה להגיע לדומיין המותאם אישית שלך | site.domain.verification_failed |
| האינטגרציה עודכנה | אינטגרציה מוגדרת, משתנה, מופעלת או כבויה | integration.updated |
| מושג מחובר | הרעיון מחובר | notion.connected |
| מושג מנותק | התפיסה מנותקת | notion.disconnected |
| גישה לרעיון אבדה | Notiondesk לא יכול יותר לקרוא את דפי ה-Notion שלך. | notion.access_lost |
| צ'אטבוט של בינה מלאכותית עודכן | הגדרות הצ'אטבוט משתנות, או שהוא מופעל או כבוי | chatbot.updated |
| נוספה הדרכה לצ'אטבוט | הנחיה נוספת לצ'אטבוט | chatbot.guidance.created |
| הנחיות הצ'אטבוט עודכנו | שינויים בהנחיה | chatbot.guidance.updated |
| הנחיות הצ'אטבוט נמחקו | הנחיה נמחקת | chatbot.guidance.deleted |
| הפניה מחדש נוספה | נוסף הפניה | redirect.created |
| הפניה מחדש עודכנה | שינויים בהפניה | redirect.updated |
| ההפניה נמחקה | הפניה מחדש נמחקת | redirect.deleted |
דומיינים מותאמים אישית נבדקים באופן קבוע, כך שאירועי דומיין עשויים להופיע מספר דקות לאחר השינוי.
סביבת עבודה
אירועי סביבת עבודה אינם קשורים למרכז עזרה אחד, ולכן ה-site_id שלהם הוא null.
| בלוח המחוונים | מִקרֶה | נשלח מתי |
|---|---|---|
| שם סביבת העבודה | שינוי שם סביבת העבודה | workspace.updated |
| בקשת הצטרפות התקבלה | מישהו מבקש להצטרף לסביבת העבודה | workspace.join_request.created |
| בקשת ההצטרפות אושרה | בקשת הצטרפות אושרה | workspace.join_request.approved |
| בקשת ההצטרפות נדחתה | בקשת הצטרפות נדחתה | workspace.join_request.declined |
| חבר לקבוצה הוזמן | חבר לקבוצה מוזמן | team_member.invited |
| חבר לקבוצה הצטרף | חבר צוות שהוזמן מקבל | team_member.joined |
| תפקיד חבר הצוות השתנה | תפקידו של חבר לקבוצה משתנה | team_member.role_changed |
| חבר לצוות מופעל או כבוי | חבר צוות מופעל או כבוי | team_member.status_changed |
| חבר הצוות הוסר | חבר צוות מוסר | team_member.removed |
| חבר צוות מחובר | חבר צוות מתחבר. נשלח רק לסביבת העבודה שהוא פותח כברירת מחדל | team_member.logged_in |
| מפתח API נוצר | נוצר מפתח API | api_key.created |
| מפתח ה-API הסתובב | מפתח API מסובב | api_key.rotated |
| מפתח ה-API בוטל | מפתח API בוטל | api_key.revoked |
| מרכז העזרה נוצר | נוצר מרכז עזרה | site.created |
| מרכז העזרה נמחק | מרכז עזרה נמחק בזמן שבסביבת העבודה עדיין קיים מרכז עזרה מקוון אחר | site.deleted |
אירוע בדיקה
| בלוח המחוונים | מִקרֶה | נשלח מתי |
|---|---|---|
| אירוע בדיקה | אתה לוחץ על שלח אירוע בדיקה בנקודת קצה | ping |
לא ניתן לבחור את ping ברשימת האירועים. הוא מגיע רק לנקודת הקצה שאתה בודק, ה-site_id שלו הוא null, והוא נשלח פעם אחת, ללא ניסיונות חוזרים.
מה כל בקשה מכילה
הפונקציה Notiondesk שולחת בקשה POST עם גוף JSON:
{
"id": "019a8f2e-4b1c-7d3e-9f40-5a6b7c8d9e01",
"event": "article.published",
"version": "2026-11-06",
"occurred_at": "2026-11-17T14:32:05+00:00",
"site_id": "019a8f2e-0b7d-7c3a-9e15-4f2a6b8c0d11",
"data": {
"article": {
"id": "1763391842",
"locale": "en",
"title": "Reset your password",
"slug": "reset-your-password",
"url": "https://help.acme-support.com/en/articles/reset-your-password",
"status": "published"
}
}
}| שָׂדֶה | מה זה |
|---|---|
id | מזהה האירוע. הוא נשאר זהה בעת ניסיון חוזר של בקשה, לכן השתמש בו כדי לזהות כפילויות |
event | שם האירוע, לדוגמה article.published |
version | גרסת פורמט הבקשה הזו |
occurred_at | מתי התרחש האירוע, כתאריך ושעה לפי תקן ISO 8601 |
site_id | מרכז העזרה שממנו מגיע האירוע, או null עבור אירועי סביבת עבודה ואירוע הבדיקה |
data | הדברים עליהם עוסק האירוע. ראה מה מכילים הנתונים |
כל בקשה נושאת גם את הכותרות הבאות:
| כּוֹתֶרֶת | עֵרֶך |
|---|---|
Content-Type | application/json |
User-Agent | ND-Webhooks/1.0 |
X-ND-Event | שם האירוע, זהה לשם event בגוף הקובץ |
X-ND-Delivery | מזהה המסירה לנקודת הקצה הזו. הוא נשאר זהה בכל ניסיונות חוזרים |
X-ND-Signature | החתימה המוכיחה שהבקשה מגיעה מ-Notiondesk. בדיקה שהיא מכוסה תחת אימות ש-webhook מגיע מ-Notiondesk |
אילו נתונים מכילים
data מכיל אובייקט אחד או יותר, בהתאם לאירוע:
| מִקרֶה | מה יש ב-data |
|---|---|
contact_message.created | __נשמר_218__: __נשמר_217__, __נשמר_216__, __נשמר_215__, __נשמר_214__, __נשמר_213__, __נשמר_212__ |
| __נשמר_211__, __נשמר_210__, __נשמר_209__, __נשמר_208__, __נשמר_207__ | __נשמר_206__: __נשמר_205__, __נשמר_204__, __נשמר_203__, __נשמר_202__, __נשמר_201__, __נשמר_200__ |
article.translated | article בשפה החדשה, ו-source_locale |
article.deleted | __נשמר_195__: __נשמר_194__ |
| __נשמר_193__, __נשמר_192__, __נשמר_191__ | article: id, ו-reaction: type |
article.feedback.created | article: id, ו-feedback: id, name, email, message, locale |
| __נשמר_177__, __נשמר_176__ | __נשמר_175__: __נשמר_174__, __נשמר_173__, __נשמר_172__, __נשמר_171__ |
category.deleted | __נשמר_169__: __נשמר_168__ |
sync.completed | __נשמר_166__: __נשמר_165__, __נשמר_164__, __נשמר_163__, __נשמר_162__ |
sync.failed | __נשמר_160__: __נשמר_159__, __נשמר_158__ |
| __נשמר_157__, __נשמר_156__ | __נשמר_155__: __נשמר_154__, __נשמר_153__, __נשמר_152__ |
site.deleted | __נשמר_150__: __נשמר_149__ |
site.custom_code.updated | custom_code: type (css או js) |
| __נשמר_143__, __נשמר_142__ | __נשמר_141__: __נשמר_140__ |
integration.updated | __נשמר_138__: __נשמר_137__, __נשמר_136__ |
| __נשמר_135__, __נשמר_134__, __נשמר_133__ | אובייקט ריק, {} |
chatbot.updated | __נשמר_130__: __נשמר_129__, __נשמר_128__, __נשמר_127__ |
| __נשמר_126__, __נשמר_125__ | __נשמר_124__: __נשמר_123__, __נשמר_122__, __נשמר_121__, __נשמר_120__ |
chatbot.guidance.deleted | __נשמר_118__: __נשמר_117__ |
| __נשמר_116__, __נשמר_115__ | __נשמר_114__: __נשמר_113__, __נשמר_112__, __נשמר_111__, __נשמר_110__, __נשמר_109__ |
redirect.deleted | __נשמר_107__: __נשמר_106__ |
workspace.updated | __נשמר_104__: __נשמר_103__, __נשמר_102__ |
| __נשמר_101__, __נשמר_100__, __נשמר_99__ | __נשמר_98__: __נשמר_97__, __נשמר_96__, __נשמר_95__ |
| __נשמר_94__, __נשמר_93__, __נשמר_92__, __נשמר_91__ | __נשמר_90__: __נשמר_89__, __נשמר_88__, __נשמר_87__, __נשמר_86__ |
team_member.removed | __נשמר_84__: __נשמר_83__ |
team_member.logged_in | __נשמר_81__: __נשמר_80__, __נשמר_79__, __נשמר_78__ |
| __נשמר_77__, __נשמר_76__ | __נשמר_75__: __נשמר_74__, __נשמר_73__, __נשמר_72__, __נשמר_71__, __נשמר_70__ |
api_key.rotated | api_key עבור המפתח החדש, ו-previous_api_key: id |
ping | message |
data לעולם לא מכיל קבצים מצורפים, סודות, קוד מותאם אישית או פרטי חיוב.
נתונים לדוגמה לפי משפחת אירועים
דוגמאות אלה מציגות רק את data. שאר הבקשה זהה עבור כל אירוע.
טופס יצירת קשר, contact_message.created:
מאמרים, article.translated:
status הוא הסטטוס של שפה זו: draft, review, published, archived או translation source. url יכול להיות null אם למרכז העזרה עדיין אין כתובת.
תגובות ומשוב, article.feedback.created:
עבור תגובות, reaction.type הוא smiley, neutral_face או disappointed. מרכזי עזרה המציגים כפתורי תמונה ממוזערת שולחים smiley עבור כן ו-disappointed עבור לא. במשוב, article.id הוא null כאשר המאמר כבר לא קיים.
קטגוריות, category.created:
מסנכרן, sync.completed ו-sync.failed:
trigger הוא manual, api או automatic. reason הוא pages_failed כאשר לא ניתן היה לסנכרן דפים מסוימים, או failed כאשר הסנכרון הופסק.
הגדרות מרכז העזרה, redirect.created:
סביבת עבודה וחברי צוות, team_member.role_changed:
role הוא admin, editor, billing_manager או viewer. status הוא enabled, disabled או pending_invite.
מפתחות API, api_key.rotated:
אירוע בדיקה, ping:
טיפול באירועים במקלט שלך
{
"contact_message": {
"id": "019a8f31-5c2e-7a41-8b9d-2e6f0a7c4b23",
"name": "Jamie Rivera",
"email": "[email protected]",
"subject": "Invoice question",
"message": "Hi, where can I download my latest invoice?",
"locale": "en"
}
}{
"article": {
"id": "1763391842",
"locale": "fr",
"title": "Réinitialiser votre mot de passe",
"slug": "reinitialiser-votre-mot-de-passe",
"url": "https://help.acme-support.com/fr/articles/reinitialiser-votre-mot-de-passe",
"status": "published"
},
"source_locale": "en"
}{
"article": { "id": "1763391842" },
"feedback": {
"id": "019a8f33-8d4f-7b52-a1c3-6e9b2d0f7a35",
"name": "Sam Lee",
"email": "[email protected]",
"message": "The screenshots don't match the new settings page.",
"locale": "en"
}
}{
"category": {
"id": "1763392017",
"locale": "en",
"name": "Billing",
"slug": "billing"
}
}{
"sync": {
"trigger": "automatic",
"duration_seconds": 42,
"pages_synced": 120,
"pages_updated": 3
}
}{
"sync": {
"reason": "pages_failed",
"pages_processed": 118
}
}{
"redirect": {
"id": "019a8f35-2a6c-7d63-b4e8-0c1f5a9d3e47",
"source_path": "/old-help/reset-password",
"type": "article",
"article_id": "1763391842",
"category_id": null
}
}{
"team_member": {
"id": "019a8f37-7e1b-7f74-8c2d-9a4e6b1f0c59",
"email": "[email protected]",
"role": "editor",
"status": "enabled"
}
}{
"api_key": {
"id": "019a8f39-3f8a-7185-9d6e-1b7c4e2a8d6b",
"prefix": "nd_wsk_4fa9c2e17b30",
"label": "CRM sync",
"scopes": ["read"],
"expires_at": null
},
"previous_api_key": { "id": "0199c4d2-6b3e-7296-ae0f-5d8a1c7e9b7d" }
}{
"message": "Test event from Notiondesk."
}- הגב במהירות. החזר תחילה כל קוד סטטוס
2xx, ולאחר מכן בצע את העבודה. Notiondesk ממתין 5 שניות עד שהשרת שלך יתחיל לענות, ו-10 שניות בסך הכל, וקורא רק את קוד הסטטוס.
- צפו לכפילויות. אותו אירוע יכול להופיע יותר מפעם אחת, לדוגמה לאחר ניסיון חוזר. דלג על כל
idשכבר עיבדת.
- אל תסתמך על סדר. אירועים יכולים להופיע בסדר לא מסוים. השתמש ב-
occurred_atכאשר הסדר חשוב.
- קריאת נתונים כמצב העדכני ביותר.
dataנקרא כאשר האירוע נשלח, כך ששני שינויים מהירים במאמר יכולים לשאת שניהם את הגרסה המאוחרת יותר. אם הפריט נעלם עד אז, האירוע מדלג.
שאלות נפוצות
האם אני מקבל את תוכן המאמר המלא?
לא. אירועי כתבה נושאים את הכותרת, הקישור, כתובת האתר והסטטוס. השתמש ב-Notiondesk API אם אתה זקוק לעוד.
איך אני יכול לדעת מאיזה מרכז עזרה מגיע אירוע?
קרא site_id. זהו המזהה של מרכז העזרה, או null עבור אירועי סביבת עבודה ואירוע הבדיקה.
למה לא קיבלתי אירוע לכל תגובה?
תגובות ומשוב למאמרים מוגבלים ל-120 אירועים בדקה עבור כל מרכז עזרה. אירועים מעבר למגבלה אינם נשלחים. השתמש בניתוח הנתונים של מרכז העזרה שלך לקבלת סיכומים.
האם אני יכול לקבל את אותו אירוע פעמיים?
כן, לדוגמה לאחר ניסיון חוזר. ה-id נשאר זהה, אז התעלם מאחד שכבר עיבדת.
מה המשמעות של גרסה?
זה אומר לך איזה פורמט בקשה היה בשימוש. בקשות משתמשות כעת ב-2026-11-06.