דלג לתוכן הראשי

Webhooks

זמין בתוכניותFreeProResearch

webhook הוא כתובת אינטרנט ש-Readsira קוראת לה כשמשהו קורה בספרייה שלכם, למשל כששומרים קישור. משתמשים בו כדי לחבר את Readsira לסקריפט, לכלי אוטומציה או לערוץ צ'אט שאתם שולטים בו. כל הודעה חתומה, כך שהמקבל שלכם יכול לבדוק שהיא באמת הגיעה מ-Readsira. אם אתם כותבים את המקבל בעצמכם, ראו Webhooks למפתחים למטענים ולבדיקת החתימה.

לפני שמתחילים​

  • אתם צריכים מקבל: כתובת https:// ציבורית שמקבלת בקשת POST עם גוף JSON. כתובות במחשב שלכם או ברשת פרטית (כמו localhost) נדחות.
  • תכננו לשמור את הסוד ש-Readsira מציגה כשמוסיפים את ה-webhook. הוא מוצג פעם אחת.

הוספת webhook​

  1. פתחו את הגדרות ובחרו Webhooks. אפשר גם לפתוח app.readsira.com/settings/webhooks.

  2. תחת הוסף webhook הקלידו את הכתובת ב-כתובת המקבל ובחרו הוסף.

    ההגדרות, Webhooks: הטופס להוספת כתובת מקבל.

  3. תיבה אומרת שמור את הסוד הזה עכשיו. הוא לא יוצג שוב. העתיקו את הסוד ושמרו אותו במקום שהמקבל שלכם יכול לקרוא.

  4. בחרו את האירועים שאתם רוצים תחת אירועים בכרטיס של ה-webhook. webhook חדש מתחיל עם bookmark.created בלבד.

  5. בחרו בדיקה. Readsira שולחת עכשיו הודעת בדיקה, והתג בכרטיס מראה את התשובה של המקבל שלכם, למשל HTTP 200.

אירועים​

אירועמתי הוא נשלח
bookmark.createdשומרים פריט
bookmark.updatedפריט משתנה
bookmark.deletedפריט נמחק
bookmark.visitedפותחים פריט
collection.created, collection.updated, collection.deletedמופיעים באפליקציה, אך עדיין לא נשלחים
output.createdתוצר של פרויקט מוכן

פריטים שייבוא מוסיף לא שולחים webhooks.

מה התג בכרטיס אומר​

  • HTTP 200 (או מספר 2xx אחר): הקריאה האחרונה עבדה.
  • מספר אחר, באדום: המקבל שלכם ענה עם שגיאה. הכרטיס מציג את טקסט השגיאה.
  • ממתין לשליחה ראשונה: Readsira עדיין לא קראה לו. השתמשו ב-בדיקה.
  • כבוי: ה-webhook כבוי.

כשהמקבל שלכם עונה עם שגיאת שרת או לא עונה בתוך 5 שניות, Readsira מנסה שוב, עד 4 ניסיונות בסך הכול, עם הפסקות ארוכות יותר ביניהם. Readsira לא עוקבת אחרי הפניות, לכן השתמשו בכתובת הסופית.

ניהול webhook​

  • החלפת סוד יוצר סוד חדש. המקבל שלכם נכשל בבדיקת החתימה עד שהוא משתמש בחדש, ולכן שנו אותו שם מיד.
  • כיבוי משהה את ה-webhook, ו-הפעלה מתחיל אותו שוב.
  • מחק מסיר אותו.

בזמן שמחיקת חשבון ממתינה בתקופת ההמתנה, webhooks מושהים (ראו מחיקת החשבון).

עודכן בתאריך