Documentation Index
Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
Use this file to discover all available pages before exploring further.
توفر مدفوعات دودو إشعارات ويب هوك في الوقت الفعلي لإبقائك على اطلاع بالأحداث الحرجة المتعلقة بالمعاملات، والاشتراكات، والاستردادات، والنزاعات، وإدارة مفاتيح الترخيص. فيما يلي دليل مفصل لهذه الأحداث، مصنفة من أجل الوضوح، مع نصائح واعتبارات للتنفيذ.
أحداث الدفع
| اسم الحدث | نوع الحدث | الوصف |
|---|
| Payment Succeeded | payment.succeeded | يتم تشغيله عند معالجة دفعة بنجاح. |
| Payment Failed | payment.failed | يحدث عندما تفشل محاولة الدفع بسبب أخطاء، بطاقات مرفوضة، أو مشكلات أخرى. |
| Payment Processing | payment.processing | يشير إلى أن الدفع قيد المعالجة حالياً. |
| Payment Cancelled | payment.cancelled | يتم تشغيله عند إلغاء الدفع قبل اكتماله. |
أحداث الاسترداد
| اسم الحدث | نوع الحدث | الوصف |
|---|
| Refund Succeeded | refund.succeeded | يتم تشغيله عند معالجة استرداد بنجاح. |
| Refund Failed | refund.failed | يحدث عندما تفشل محاولة الاسترداد بسبب أخطاء في المعالجة أو مشكلات أخرى. |
أحداث النزاع
| اسم الحدث | نوع الحدث | الوصف |
|---|
| Dispute Opened | dispute.opened | يتم تشغيله عندما يبدأ العميل نزاعاً. |
| Dispute Expired | dispute.expired | يشير إلى أن النزاع انتهى دون تسوية. |
| Dispute Accepted | dispute.accepted | يتم تشغيله عندما يقبل التاجر النزاع. |
| Dispute Cancelled | dispute.cancelled | يحدث عندما يتم إلغاء النزاع بواسطة العميل أو النظام. |
| Dispute Challenged | dispute.challenged | يتم تشغيله عندما يتحدى التاجر النزاع. |
| Dispute Won | dispute.won | يشير إلى أن التاجر فاز بالنزاع بنجاح. |
| Dispute Lost | dispute.lost | يحدث عندما يخسر التاجر النزاع. |
أحداث الاشتراك
| اسم الحدث | نوع الحدث | الوصف |
|---|
| Subscription Active | subscription.active | يشير إلى أن الاشتراك نشط الآن وتم جدولة الرسوم المتكررة. |
| Subscription Updated | subscription.updated | يتم تشغيله عند تحديث أي حقل في الاشتراك (مزامنة فورية بدون استعلام). |
| Subscription On Hold | subscription.on_hold | يتم تشغيله عندما يتم تعليق الاشتراك مؤقتاً بسبب فشل التجديد. |
| Subscription Renewed | subscription.renewed | يحدث عندما يتم تجديد الاشتراك بنجاح. |
| Subscription Plan Changed | subscription.plan_changed | يتم تشغيله عندما يتم ترقية الاشتراك أو تخفيضه أو تعديله بإضافات مختلفة. |
| Subscription Cancelled | subscription.cancelled | يتم تشغيله عند إلغاء الاشتراك من قبل التاجر أو العميل. |
| Subscription Failed | subscription.failed | يشير إلى فشل الاشتراك. هذا يعني أننا لم نتمكن من إنشاء تفويض. |
| Subscription Expired | subscription.expired | يتم تشغيله عندما يصل الاشتراك إلى نهاية مدته وينتهي. |
أحداث مفتاح الترخيص
| اسم الحدث | نوع الحدث | الوصف |
|---|
| License Key Created | license_key.created | يتم تشغيله عند إنشاء مفتاح ترخيص جديد لمنتج. |
أحداث منح الاستحقاق
| اسم الحدث | نوع الحدث | الوصف |
|---|
| منح تم إنشاؤه | entitlement_grant.created | تم إنشاء منحة استحقاق جديدة للعميل. تصل منح مفتاح الترخيص delivered؛ وتصل المنح التي تعتمد على OAuth (ديسكورد، جيت هاب، نوتيون) pending. |
| منح تم تسليمه | entitlement_grant.delivered | اكتملت تنفيذ المنحة — تم إصدار مفتاح الترخيص، حل روابط الملفات، أو منح الوصول إلى المنصة. |
| فشل المنح | entitlement_grant.failed | فشل في تنفيذ المنحة؛ تحقق من error_code و error_message. |
| منح تم إلغاؤه | entitlement_grant.revoked | تم سحب الوصول؛ تحقق من revocation_reason (حالة الاشتراك، الاسترداد، تغيير الخطة، أو يدويًا). |
revocation_reason، انظر ويب هوك منح الاستحقاق.
أحداث الرصيد
| اسم الحدث | نوع الحدث | الوصف |
|---|
| إضافة رصيد | credit.added | يتم تفعيله عند منح أرصدة للعميل (الاشتراك، مرة واحدة، الإضافات، أو API). |
| خصم الرصيد | credit.deducted | يحدث عند استهلاك الأرصدة من خلال الاستخدام أو الخصم اليدوي. |
| انتهاء صلاحية الرصيد | credit.expired | يتم تفعيله عند انتهاء صلاحية الأرصدة غير المستخدمة بعد فترة انتهاء صلاحية محددة. |
| ترحيل الرصيد | credit.rolled_over | يحدث عندما يتم ترحيل الأرصدة غير المستخدمة إلى منحة جديدة في نهاية الدورة. |
| فقدان الترحيل | credit.rollover_forfeited | يتم تفعيله عندما يتم خسارة الأرصدة لأن الحد الأقصى لترحيلها تم الوصول إليه. |
| تحميل زائد | credit.overage_charged | يحدث عندما يتم تطبيق رسوم إضافية على الاستخدام بعد الرصيد الصفري. |
| تعديل يدوي | credit.manual_adjustment | يتم تفعيله عندما يتم إجراء تعديل يدوي على الرصيد أو الخصم. |
| انخفاض الرصيد | credit.balance_low | يتم تفعيله عندما ينخفض رصيد الرصيد إلى ما دون الحد المكون. |
أحداث الاسترداد
| اسم الحدث | نوع الحدث | الوصف |
|---|
| تم اكتشاف إتمام الشراء المتروك | abandoned_checkout.detected | يتم تفعيله عند اكتشاف إتمام شراء غير مكتمل أو فاشل بعد 60 دقيقة. |
| استرداد إتمام الشراء المتروك | abandoned_checkout.recovered | يحدث عندما يكمل العميل الدفع عبر رابط استرداد. |
أحداث التحصيل
| اسم الحدث | نوع الحدث | الوصف |
|---|
| بداية التحصيل | dunning.started | يتم تفعيله عندما تبدأ محاولة لتحصيل الاشتراك الذي تم تعليقه أو إلغاؤه. |
| استرداد التحصيل | dunning.recovered | يحدث عندما يقوم العميل بتحديث طريقة الدفع الخاصة بهم وتنجح الشحنة الناتجة. |
