שימוש ב-Webhooks כדי לקבל עדכוני סטטוס מסמכים
🔔 קבל עדכונים אוטומטיים כשהמסמך שלך מוכן
רוצה לקבל עדכונים בזמן אמת כאשר המסמכים שלך מעובדים? השתמש ב-webhooks כדי להודיע אוטומטית למערכת שלך כאשר קובץ הושלם.
🔑 הפק את המפתח הסודי של ה-Webhook שלך
עבור אל הגדרות > אינטגרציית API
תחת צור מפתח סודי של Webhook , לחץ על צור מפתח סודי
מפתח זה משמש לחתימה ואימות של התראות webhook נכנסות
שמור את המפתח שלך מאובטח. אם תיצור אותו מחדש, הקפד לעדכן אותו במערכת הטיפול ב-webhook שלך.
🔧 הגדר Webhook דרך ה-API
כדי להתחיל לקבל אירועי השלמת מסמכים, השתמש בקטע Webhooks בהגדרות > תיעוד API .
🔹 צור Webhook
POST /v1/admin/company/webhooks
דוגמה לגוף:
urlחייבת להיות נקודת קצה מאובטחתHTTPSשיכולה לקבל בקשותPOST.eventצריך להיות"file_processed"(בינתיים, זה האירוע הזמין).
🔹 רשימה של כל ה-Webhooks
GET /v1/admin/company/webhooks
מחזירה את רשימת ה-webhooks שכבר הוגדרה בחשבון החברה שלך.
🔹 מחק Webhook
DELETE /v1/admin/company/webhooks/{id}
השתמש בנקודת קצה זו כדי להסיר webhook באמצעות המזהה שלו.
✅ דוגמה לשימוש במקרה
לאחר רישום ה-webhook שלך, תקבל בקשת POST כאשר עיבוד המסמך יסתיים.
תגובה לדוגמה:
ודא שנקודת הקצה שלך יכולה לטפל ולאמת את הבקשה באמצעות המפתח הסודי של Webhook שלך.