הגדר Webhooks לקבלת עדכוני סטטוס מסמכים

שימוש ב-Webhooks כדי לקבל עדכוני סטטוס מסמכים

🔔 קבל עדכונים אוטומטיים כשהמסמך שלך מוכן

רוצה לקבל עדכונים בזמן אמת כאשר המסמכים שלך מעובדים? השתמש ב-webhooks כדי להודיע אוטומטית למערכת שלך כאשר קובץ הושלם.


🔑 הפק את המפתח הסודי של ה-Webhook שלך

  1. עבור אל הגדרות > אינטגרציית API

  2. תחת צור מפתח סודי של Webhook , לחץ על צור מפתח סודי

  3. מפתח זה משמש לחתימה ואימות של התראות 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 שלך.

    • Related Articles

    • העלאת מסמכים דרך API

      ? העלה מסמכים ישירות מהפלטפורמה שלך השתמש ב- API להעלאת קבצים כדי לשלוח קבצים להנגשה מהמערכת או האפליקציה שלך. ? העלה נקודת קצה POST /v1/external/user/files ? דוגמה לגוף הבקשה: ? שדות מוסברים: נדרשים name , size mime tags comments הם אופציונליים ...

    • אחזור והורדת קבצים באמצעות ה-API

      ? חפש, הצג והורד מסמכים לאחר ההעלאה, תוכל להשתמש ב-API כדי לבדוק ולהוריד קבצים. ? קבל את כל הקבצים (מנהלי חברה) GET /v1/external/admin/company/files תומך במסננים כמו: users (מערך מזהי משתמש) tags , search , sort_by , order , limit , skip התגובה ...

    • סקירה כללית של AccessibleDocs

      AccessibleDocs הוא כלי המופעל על ידי בינה מלאכותית שנועד להפוך מסמכים דיגיטליים לנגישים לחלוטין לאנשים עם מוגבלויות. הוא מבטיח עמידה בתקני נגישות בינלאומיים כמו PDF/UA , מה שהופך מסמכים לקלים יותר לקריאה ולשימוש עבור משתמשי קוראי מסך ואנשים עם לקויות ...

    • כיצד ליצור את מפתח ה-API שלך

      כדי להשתמש ב-API, תחילה יהיה עליך ליצור את מפתח ה-API שלך. שלבים: עבור אל הגדרות > אינטגרציית API תחת צור מפתח API , לחץ על צור מפתח API המפתח שלך יופיע בשדה - לחץ על העתק כדי להשתמש בו במערכת שלך השתמש במפתח זה בקריאות ה-API שלך על ידי הכללתו ...

    • סטטוס עיבוד מסמך מעקב

      AccessibleDocs מספק עדכוני סטטוס מסמכים בזמן אמת . ? מחווני סטטוס: ✅ אימות – בדיקת ספירת העמודים של המסמך. ✅ בתהליך - המסמך נמצא כעת בעיבוד. ✅ הושלם - הקובץ נגיש כעת ומוכן להורדה. ✅ חריגה מהמכסה - הקובץ חורג ממגבלת העמודים שלך (דורש דפים נוספים).