סקירה כללית

ה-Webhooks של דרימפו מאפשרים ליישום שלך לקבל התראות בזמן אמת כאשר מידע משתנה בארגון הניהול שלך. במקום לבצע Polling מול ה-API, אתה מספק כתובת URL, ואנחנו שולחים בקשת HTTP POST לכתובת זו בכל פעם שמתרחש אירוע רלוונטי.

למה אפשר להירשם #

איך זה עובד #

1. אתה רושם כתובת URL ל-Webhook ובוחר אילו סוגי ישויות תרצה לקבל.
2. אתה יוצר Secret Token (שמור אותו — לא נציג אותו שוב).
3. כאשר אירוע מתרחש בארגון שלך, דרימפו שולחת בקשת POST לכתובת שלך עם Payload בפורמט JSON.
4. השרת שלך מאמת את כותרת X-Webhook-Secret ומעבד את האירוע.

דרישות מנקודת הקצה שלך #

• כתובת HTTPS ציבורית וזמינה
• מחזירה HTTP 2xx בתוך זמן סביר
• מסוגלת לטפל במשלוחים כפולים (Idempotent)
• מאמתת את כותרת X-Webhook-Secret בכל בקשה

התחלה מהירה

הפעל את ה-Webhook הראשון שלך תוך 5 דקות.

שלב 1 — הכן נקודת קצה ציבורית #

נקודת הקצה שלך חייבת להיות:

• כתובת HTTPS ציבורית (לדוגמה: https://your-app.com/darimpo-webhooks)
• לקבל POST עם גוף JSON
• להחזיר 200 OK במהירות האפשרית

שלב 2 — רשום את ה-Webhook במערכת דרימפו #

רישום וניהול Webhooks מתבצע כולו מתוך מערכת דרימפו, לא באמצעות קריאות API.

1. היכנס למערכת דרימפו בכתובת manager.darimpo.com עם שם המשתמש והסיסמה שלך.
2. בתפריט העליון, עבור ל-הגדרות ← Webhooks.
3. לחץ על הוסף Webhook והזן:
   • URL — כתובת נקודת הקצה שלך
   • שם — שם תיאורי להצגה
   • סוגי ישויות — בחר אילו אירועים תרצה לקבל (קריאות שירות, חשבוניות וכו')
4. שמור. המערכת תיצור Webhook פעיל ותציג את ה-Secret Token.

שלב 3 — שמור את ה-Secret Token #

לאחר שמירת ה-Webhook, המערכת מציגה את ה-secretToken:

ה-Token הזה הוא מה שישלח בכל בקשה שדרימפו תפנה לשרת שלך, ובאמצעותו השרת שלך יאמת שהבקשה אכן הגיעה מדרימפו.

שלב 4 — טפל באירועים נכנסים #

דרימפו תשלח בקשות POST בצורה הבאה:

// Headers
Content-Type: application/json
X-Webhook-Secret: 123456

// Body
{
  "event": "created",
  "entityType": "tax_invoice",
  "entityId": 1599173,
  "webhookId": 1,
  "timestamp": 1777174160730,
  "data": {
    "id": 1599173,
    "lastUpdated": 1777174160461,
    "apartmentId": 741,
    "payment": 1,
    "type": 0,
    "transactionType": 1
  }
}

השרת שלך צריך:

1. לאמת שה-X-Webhook-Secret תואם לטוקן ששמרת.
2. להחזיר 200 OK מיד.
3. לעבד את האירוע באופן אסינכרוני.

שלב 5 — בדוק את זה #

הפעל את האירוע מממשק המשתמש של דרימפו (לדוגמה, צור חשבונית מס). נקודת הקצה שלך אמורה לקבל את ההתראה תוך שניות.

אימות ואבטחה

כל בקשת Webhook מדרימפו כוללת כותרת עם Secret Token. עליך לאמת אותה לפני עיבוד ה-Payload.

ה-Secret Token #

ה-secretToken שהוצג ביצירת ה-Webhook הוא מפתח משותף בין השרת שלך לדרימפו. הוא משמש לאימות שכל בקשה נכנסת הגיעה באמת מדרימפו ולא מגורם חיצוני.

חשוב:

• ה-Token מוצג רק ביצירת ה-Webhook ולא ניתן להציגו שוב במערכת.
• אחסן את ה-Token במנהל Secrets או במשתני סביבה — לעולם לא בקוד.

אם איבדת את ה-Token, תצטרך ליצור Webhook חדש, או לבצע רוטציה דרך ממשק הניהול.

הכותרת X-Webhook-Secret #

כאשר דרימפו שולחת Webhook, בקשת ה-HTTP כוללת:

X-Webhook-Secret: wh_sk_9c2b4a7e8f1d...

הערך תואם ל-secretToken שנוצר ברישום ה-Webhook.

מה השרת שלך צריך לעשות #

בכל בקשה נכנסת:

1. קרא את הכותרת X-Webhook-Secret.
2. השווה אותה ל-Token ששמרת עבור Webhook זה.
3. אם הערכים לא תואמים או שהכותרת חסרה — החזר 401 Unauthorized ואל תמשיך לעבד.
4. לשם אבטחה מוגברת, השתמש בהשוואה בזמן קבוע (Timing-safe comparison) כדי למנוע התקפות תזמון.

שיטות עבודה מומלצות באבטחה #

• תמיד הגש את נקודת הקצה שלך מעל HTTPS
• שמור Secrets במנהל Secrets או במשתני סביבה, לעולם לא בקוד
• השתמש בהשוואה בזמן קבוע
• דחה בקשות ללא הכותרת עם 401
• אל תרשום ערכי Secret בלוגים
• אל תקבל Webhooks מעל HTTP רגיל (לא מוצפן)

ניהול Webhooks

רישום, עדכון ומחיקה של Webhooks מתבצעים כולם מתוך מערכת דרימפו, לא באמצעות קריאות API.

רישום Webhook חדש #

1. היכנס למערכת דרימפו בכתובת manager.darimpo.com.
2. בתפריט העליון, עבור ל-הגדרות ← Webhooks.
3. לחץ על הוסף Webhook והזן URL, שם וסוגי ישויות.
4. שמור. המערכת תציג את ה-Secret Token — שמור אותו מיד, הוא לא יוצג שוב.

למדריך המלא #

ניהול מפורט של Webhooks — כולל עריכה, השבתה, מחיקה, רוטציית Secret, וניטור משלוחים — מכוסה במדריך הניהול הנפרד.

לפרטים טכניים על מבנה הבקשות שתקבל, עבור ל-מבנה ה-Payload.

סוגי אירועים

משלוח Webhook מורכב משני מזהים: entityType — איזה סוג של אובייקט השתנה, ו-event — מה קרה לו.

סוגי ישויות #

בעת רישום Webhook, העבר את מזהי הישויות כמספרים שלמים במערך entityTypes.

אירועים #

השדה event ב-Payload יהיה אחד מאלה:

אירועים שנשלחים לכל ישות #

לא כל ישות פולטת כל אירוע. הטבלה הבאה מראה מה תקבל בפועל:

מקרה מיוחד: מחיקת הוצאה

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

1. deleted — ההוצאה המקורית
2. created — הוצאת זיכוי (Reversal)

זה משקף את אופן מעקב המחיקות בחשבונאות. טפל בשני האירועים בשילוב שלך.

מקרה מיוחד: זיכויי חשבונית מס

כאשר חשבונית מס מבוטלת עם הודעת זיכוי, אתה מקבל אירוע created לחשבונית חדשה שבה:

• creditType מוגדר
• parentId מפנה לחשבונית המקורית

מבנה ה-Payload

כל משלוחי ה-Webhook חולקים את אותו מעטפת. רק data משתנה לפי סוג הישות.

מעטפת #

{
  "event": "created",
  "entityType": "tax_invoice",
  "entityId": 1599173,
  "webhookId": 1,
  "timestamp": 1777174160730,
  "data": { ... }
}

שדות בסיס לכל הישויות #

כל הישויות כוללות את שדות הבסיס הללו:

סוגי שדות לפי סיומת

service_call #

{
  "id": 472871,
  "lastUpdated": 1777173826103,
  "status": 0,
  "reportedDate": 1777173825995,
  "resolvedDate": 0,
  "buildingFacilityId": 836,
  "buildingFacilityName": "אחר",
  "isPublic": true,
  "isEmergency": false,
  "descriptionDone": "",
  "description": "תקלת בדיקה",
  "buildingId": 401,
  "dueDateReminder": 0,
  "areaId": 34760,
  "fullAddress": "ליגד סנטר 2, קומה 1",
  "area": {
    "id": 34760,
    "name": "1",
    "lastUpdated": 0
  },
  "serviceCallAvgUrgency": {
    "urgency": 0,
    "usersCount": 1
  }
}

שדות

area (אובייקט)

serviceCallAvgUrgency (אובייקט)

הדחיפות מחושבת כממוצע על בסיס הצבעות של משתמשים שצפו בקריאה.

status

urgency (בתוך serviceCallAvgUrgency)

schedual_review #

{
  "id": 29526,
  "lastUpdated": 1777174075835,
  "isPartialExecution": false,
  "lastReviewDate": 0,
  "reviewDaysFrequancy": 7,
  "name": "ביקורת תקופתית",
  "checklist": "{\"lastId\":0, \"selectedIds\":[], \"items\":[]}",
  "description": "ביקורת עבור webhooks",
  "buildingId": 401,
  "dueDateReminder": 1776157200000,
  "areaId": 0
}

שדות

ל-schedual_review אין שדות Enum ייחודיים.

organization_task #

{
  "id": 45122,
  "lastUpdated": 1777173940716,
  "status": 1,
  "type": 2,
  "urgency": 0,
  "reportedDate": 1777173940700,
  "isEmergency": false,
  "description": "משימה ארגונית",
  "buildingId": 2142,
  "dueDateReminder": 1777194000000,
  "areaId": 0
}

שדות

status

urgency

type (סוג משימה)

tax_invoice #

{
  "id": 1599173,
  "lastUpdated": 1777174160461,
  "apartmentId": 741,
  "apartmentAddress": "ליגד סנטר 2, דירה 2",
  "buildingTaxPricingModelName": "ועד בית - 2026",
  "months": [
    {
      "month": 3,
      "payment": 1,
      "id": 2131254,
      "lastUpdated": 0
    }
  ],
  "creditTaxInvoiceId": 0,
  "payment": 1,
  "type": 0,
  "transactionType": 1,
  "actualPayDate": 1777174157491,
  "repaymentDate": 1777181357491,
  "deletedId": 0,
  "parentId": 0,
  "isDeposit": false,
  "notes": "",
  "description": "ועד בית ליגד סנטר 2 דירה 2"
}

שדות

months[] (פריט בודד)

type (אמצעי תשלום)

transactionType

expense #

{
  "id": 168024,
  "lastUpdated": 1777174252079,
  "taskId": 0,
  "taskType": 0,
  "payment": 100,
  "description": "הוצאה עבור webhooks",
  "actualPayDate": 1777323600000,
  "repaymentDate": 1777323600000,
  "buildingId": 401,
  "deletedId": 0,
  "parentId": 0,
  "paymentType": 0,
  "transactionType": 1,
  "type": 2,
  "isPaid": true,
  "fullAddress": "ליגד סנטר 2, קומה 2"
}

שדות

paymentType (אמצעי תשלום)

זהה ל-type של חשבונית מס:

type (סוג הוצאה)

transactionType

הערות חשובות #

• שדות לא מסומנים אינם נכללים ב-Payloads — רק השדות המתועדים לעיל.
• שדות חדשים עשויים להתווסף בעתיד. ה-Parser שלך צריך להתעלם משדות לא ידועים.
• תאריך 0 משמעו "לא מוגדר".
• ערכי Enum עשויים להתפתח — התייחס לערכים לא ידועים כ-"לא ידוע" במקום להיכשל.

שיטות עבודה מומלצות

המלצות לבניית אינטגרציית Webhooks אמינה ומאובטחת.

הגב מהר #

החזר 200 OK במהירות האפשרית — רצוי בפחות מ-3 שניות. בצע את העבודה האמיתית ב-Background Job, Queue או Worker.

// טוב: מגיב מיד, מעבד באופן אסינכרוני
app.post('/darimpo-webhooks', (req, res) => {
  res.status(200).send('OK');
  queue.push(req.body);
});

היה Idempotent #

דרימפו עשויה למסור את אותו אירוע יותר מפעם אחת (ניסיונות רשת חוזרים, השרת שלך החזיר 5xx וכו').

השתמש ב-entityId + event + timestamp כמפתח לזיהוי כפילויות:

const key = `${body.entityId}:${body.event}:${body.timestamp}`;
if (await alreadyProcessed(key)) return; // דלג על כפילות
await markProcessed(key);
await doTheWork(body);

מאגרי Idempotency נפוצים: Redis SETNX, אינדקס ייחודי בבסיס נתונים, טבלת Idempotency-key.

טפל בניסיונות חוזרים בחן #

ודא שנקודת הקצה שלך זמינה. אם היא לא פעילה למשך זמן ממושך, אירועים עלולים ללכת לאיבוד.

אמת את ה-Secret בכל בקשה #

לעולם אל תדלג על אימות חתימה — גם בפיתוח. ראה אימות ואבטחה.

הסדר לא מובטח #

אירועים עשויים להגיע לא לפי סדר. עצב Handlers שישתמשו ב-timestamp או במצב הישות (לא בסדר המשלוח) כמקור האמת.

הירשם בצמצום #

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

התעלם משדות לא ידועים #

דרימפו עשויה להוסיף שדות חדשים ל-Payloads ללא הודעה. Parsers שנכשלים על שדות לא ידועים יישברו.

• JSON.parse(body) — טוב
• אימות סכמה קפדני שדוחה שדות נוספים — רע

רשום הכל בלוגים (בזהירות) #

רשום בלוגים עבור כל משלוח:

• webhookId
• entityId
• event
• timestamp
• סטטוס HTTP שהחזרת

בדיקות #

• פיתוח מקומי: השתמש ב-ngrok או Cloudflare Tunnel כדי לחשוף את השרת המקומי שלך.
• בדיקה: webhook.site נותן לך כתובת חד-פעמית שמציגה את כל הבקשות הנכנסות. מצוין לגילוי.
• Staging: רשום Webhook נפרד שמצביע לסביבת ה-Staging שלך. לעולם אל תבדוק מול פרודקשן.

קצב ונפח #

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

צ'קליסט לפני עלייה לאוויר #

• נקודת קצה HTTPS פרוסה
• Secret מאוחסן במשתני סביבה / מנהל Secrets (לא בקוד)
• השוואת Secret בזמן קבוע
• מפתח Idempotency על כל אירוע
• מחזיר 200 בפחות מ-3 שניות
• מטפל ב-created, updated, ו-deleted (היכן שרלוונטי)
• ניטור / התראות על משלוחים שנכשלו
• נוהל עבודה לרוטציית Secret

צריך עזרה? #

פנה לתמיכת דרימפו עם:

• ה-id של ה-Webhook שלך
• ה-timestamp של המשלוח החסר/כושל
• קוד סטטוס HTTP שהשרת שלך החזיר