Skip to main content

نظرة عامة

بدلًا من الاستعلام عن GET /jobs/{id} بشكل متكرر، يمكنك توفير رابط ويب هوك لتلقّي طلب POST عند اكتمال المهمة. هذا أكثر كفاءة ويُقلل من مكالمات API غير الضرورية.

استخدام الويب هوك

أضف رأس X-Webhook-URL إلى أي طلب توليد. عندما تصل المهمة إلى حالة نهائية (مكتملة أو فاشلة أو ملغاة)، سترسل واجهة API طلب POST إلى رابطك يحتوي على بيانات المهمة الكاملة.

حمولة الويب هوك

عند اكتمال المهمة، يتلقى رابط الويب هوك طلب POST مع بيانات المهمة:

أفضل الممارسات

استجب بسرعة - أرجع رمز حالة 2xx على الفور. عالج بيانات الويب هوك بشكل غير متزامن عند الحاجة.
تحقق من الحمولة - تأكّد من أن job_id يطابق مهمة بدأتها قبل معالجة النتائج.
  • استخدم نقاط نهاية HTTPS للأمان
  • نفّذ آلية عدم التكرار لتفادي التسليمات المكررة
  • سجّل استلام الويب هوك لأغراض التصحيح

الويب هوك مقابل الاستعلام

استخدم الويب هوك عندما يكون لديك خادم يمكنه استقبال طلبات HTTP. استخدم الاستعلام للتطبيقات على جانب العميل أو عندما لا يمكنك عرض نقطة نهاية عامة.

الخطوات التالية

دورة حياة المهمة

تعرّف على حالات المهمة والاستعلام عن الحالة

أمثلة الكود

اطّلع على أمثلة كاملة تتضمن معالجة الويب هوك