betool betool

תיעוד

Webhook HTTP

קבלה כללית של אירועי HTTP חתומים מכל מערכת.

Webhook HTTP

ערוץ הwebhook הוא הכניסה הכללית לחיבור כל מערכת שיודעת לבצע POST HTTP. זוהי האפשרות לבחור כאשר אין ערוץ ייעודי למקור שלכם.

מתי להשתמש

  • חיבור כלי פנים-ארגוני (ERP, אפליקציה עסקית, gateway תשלומים).
  • קבלת אירועים מפלטפורמת צד שלישי המציעה webhooks (Stripe, Shopify, SendGrid…).
  • הפעלת pipeline מ-cron חיצוני או מ-CI.

הגדרה

  1. ניהול → Webhooks → כניסה חדשה.
  2. בחרו את ה-pipeline היעד.
  3. betool מייצרת URL ציבורי (https://platform.betool.ai/entries/webhook/<id>) וסוד HMAC.

הסוד משמש לחתימת כל payload: המערכת שלכם חייבת לחשב HMAC-SHA256(secret, body) ולהעביר אותו ב-header X-Betool-Signature. בקשות ללא חתימה תקפה נדחות.

פורמט ה-payload

אתם שולחים כל JSON שתרצו. betool אינה מגבילה את המבנה. ה-payload חשוף ל-pipeline תחת webhook.payload (עם תת-המפתחות שלו).

דוגמה:

curl -X POST https://platform.betool.ai/entries/webhook/abc123 \
  -H "Content-Type: application/json" \
  -H "X-Betool-Signature: $SIGNATURE" \
  -d '{
    "type": "order.created",
    "order_id": "ord_42",
    "amount_cents": 9900,
    "customer_email": "client@exemple.com"
  }'

ה-pipeline יכול אז לחבר סוכן הקורא את webhook.payload.customer_email ו-webhook.payload.amount_cents ישירות.

תגובה

כברירת מחדל, תגובת ה-HTTP מחזירה מיד 202 Accepted (ה-pipeline מופעל ברקע). אם אתם רוצים להמתין לתוצאת ה-pipeline, הגדירו את ה-webhook במצב סינכרוני — הבקשה נחסמת עד לסיום ה-pipeline (timeout של 30 שניות).

אבטחה

  • חתמו תמיד על הבקשות שלכם (HMAC).
  • הסוד ניתן לחידוש מממשק הניהול (rotation).
  • ה-payloads מאוחסנים בטקסט ברור בהיסטוריית הביצועים — אל תשלחו נתונים שנועדו להיות מוצפנים בזמן העברה בלבד.