إنتقل إلى المحتوى الرئيسي

Webhooks

متاح فيFreeProResearch

الـ webhook هو عنوان ويب تستدعيه Readsira عندما يحدث شيء في مكتبتك، مثل حفظ رابط. تستخدمه لربط Readsira بسكربت أو بأداة أتمتة أو بقناة محادثة تتحكم بها. كل رسالة موقّعة، فيستطيع مستقبِلك التحقق من أنها جاءت فعلاً من Readsira. وإذا كتبت المستقبِل بنفسك، فراجع Webhooks للمطورين لمعرفة الحمولات والتحقق من التوقيع.

قبل أن تبدأ​

  • تحتاج إلى مستقبِل: عنوان عام https:// يقبل طلب POST بجسم JSON. العناوين على حاسوبك أو شبكتك الخاصة (مثل localhost) مرفوضة.
  • خطط لتخزين السر الذي تعرضه Readsira عند إضافة الـ webhook. يظهر مرة واحدة.

إضافة webhook​

  1. افتح الإعدادات واختر Webhooks. يمكنك أيضاً فتح app.readsira.com/settings/webhooks.

  2. تحت إضافة webhook، اكتب عنوانك في رابط المستقبِل واختر إضافة.

    الإعدادات، Webhooks: نموذج إضافة عنوان URL للمستقبِل.

  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 مؤقتاً (راجع حذف حسابك).

آخر تحديث في