دليل Webhook Events

يُصدر Dodo Payments Webhook Events في كل مرحلة من مراحل دورة حياة الدفع أو الاشتراك أو النزاع أو التحويل المالي أو الرصيد أو مفتاح الترخيص. تسرد هذه الصفحة جميع الأحداث حسب المورد. للاطلاع على مخططات الحمولة التفصيلية وأمثلة المعالجات، راجع الصفحات الخاصة بكل مورد والمرتبطة أدناه.

أحداث الدفع

الحدث	يتم تشغيله عندما
`payment.succeeded`	تتم معالجة الدفع بنجاح.
`payment.failed`	تفشل محاولة الدفع بسبب رفض البطاقات أو عدم كفاية الرصيد أو أخطاء أخرى.
`payment.processing`	تكون معالجة الدفع جارية.
`payment.cancelled`	يتم إلغاء الدفع قبل اكتماله.

للاطلاع على مخطط الحمولة الكامل، راجع Webhooks الدفع.

أحداث Refund

الحدث	يتم تشغيله عندما
`refund.succeeded`	تتم معالجة Refund بنجاح.
`refund.failed`	تفشل محاولة Refund بسبب أخطاء في المعالجة أو مشكلات أخرى.

للاطلاع على مخطط الحمولة الكامل، راجع Webhooks الخاصة بـ Refund.

أحداث Dispute

الحدث	يتم تشغيله عندما
`dispute.opened`	يفتح حامل البطاقة Dispute بشأن دفعة.
`dispute.challenged`	يتم تقديم الأدلة للطعن في Dispute.
`dispute.accepted`	يتم قبول Dispute دون الطعن فيه.
`dispute.cancelled`	يتم سحب Dispute أو إلغاؤه.
`dispute.expired`	تنقضي مهلة الرد دون التوصل إلى حل.
`dispute.won`	يتم حل Dispute لصالحك.
`dispute.lost`	يتم حل Dispute لصالح حامل البطاقة.

للاطلاع على مخططات الحمولة التفصيلية وأمثلة المعالجات، راجع Webhooks الخاصة بـ Dispute.

أحداث Subscription

الحدث	يتم تشغيله عندما
`subscription.active`	يتم تفعيل Subscription بنجاح وجدولة الرسوم المتكررة.
`subscription.updated`	يتغير أي حقل في Subscription (مزامنة فورية دون polling).
`subscription.past_due`	تفشل عملية التجديد وتبدأ فترة السماح؛ ويحتفظ العميل بإمكانية الوصول حتى الموعد النهائي.
`subscription.on_hold`	يتم تعليق Subscription مؤقتًا بسبب فشل التجديد.
`subscription.paused`	يتم إيقاف Subscription مؤقتًا.
`subscription.unpaused`	تتم استئناف Subscription متوقفة مؤقتًا.
`subscription.renewed`	يتم تجديد Subscription بنجاح لفترة الفوترة التالية.
`subscription.plan_changed`	تتم ترقية Subscription أو تخفيضها أو تعديلها بإضافات مختلفة.
`subscription.update_payment_method`	يتم تحديث طريقة دفع Subscription.
`subscription.cancelled`	يتم إلغاء Subscription من قِبل التاجر أو العميل.
`subscription.failed`	يفشل إنشاء Subscription أثناء إنشاء التفويض.
`subscription.expired`	تصل Subscription إلى نهاية مدتها وتنتهي صلاحيتها.

للاطلاع على مخططات الحمولة التفصيلية وأمثلة المعالجات، راجع Webhooks الخاصة بـ Subscription.

أحداث License Key

الحدث	يتم تشغيله عندما
`license_key.created`	يتم إنشاء مفتاح ترخيص جديد لمنتج.

للاطلاع على مخطط الحمولة الكامل، راجع Webhooks الخاصة بمفاتيح الترخيص.

أحداث Entitlement Grant

الحدث	يتم تشغيله عندما
`entitlement_grant.created`	يتم إنشاء Entitlement Grant جديد لعميل. تصل منح مفاتيح الترخيص التي يتم تنفيذها تلقائيًا ومنح feature flag مع `status: "Delivered"`، ولا تُصدر حدث `delivered` منفصلًا. تصل المنح الأخرى، بما فيها مفاتيح الترخيص التي يتم تنفيذها يدويًا، مع `Pending`. راجع Entitlement Grant.
`entitlement_grant.delivered`	يكتمل تنفيذ المنحة — إصدار مفتاح الترخيص أو حل روابط الملفات أو منح الوصول إلى المنصة.
`entitlement_grant.failed`	يفشل تنفيذ المنحة. تحقّق من `error_code` و`error_message` في الحمولة.
`entitlement_grant.revoked`	يتم سحب الوصول. تحقّق من `revocation_reason` في الحمولة.

للاطلاع على مخططات الحمولة التفصيلية والأحداث النموذجية والمرجع الكامل لـ revocation_reason، راجع Webhooks الخاصة بـ Entitlement Grant.

أحداث Credit

الحدث	يتم تشغيله عندما
`credit.added`	يتم منح Credits لعميل (عبر Subscription أو عملية شراء لمرة واحدة أو إضافة أو API).
`credit.deducted`	يتم استهلاك Credits عبر الاستخدام أو الخصم اليدوي.
`credit.expired`	تنتهي صلاحية Credits غير المستخدمة بعد فترة الانتهاء المُهيأة.
`credit.rolled_over`	يتم ترحيل Credits غير المستخدمة إلى منحة جديدة عند نهاية الدورة.
`credit.rollover_forfeited`	يتم فقدان Credits لأن الحد الأقصى لعدد عمليات الترحيل قد تم بلوغه.
`credit.overage_charged`	يتم تطبيق رسوم التجاوز على الاستخدام الذي يتجاوز الرصيد الصفري.
`credit.overage_reset`	تتم إعادة تعيين رسوم التجاوز المتراكمة (على سبيل المثال، عند بدء دورة فوترة جديدة).
`credit.manual_adjustment`	يتم إجراء تعديل يدوي على الرصيد الدائن أو المدين.
`credit.balance_low`	ينخفض رصيد Credits عن الحد الأدنى المُهيأ.

للاطلاع على مخططات الحمولة التفصيلية وأمثلة المعالجات، راجع Webhooks الخاصة بالفوترة المستندة إلى Credits.

أحداث Recovery

الحدث	يتم تشغيله عندما
`abandoned_checkout.detected`	يتم اكتشاف Checkout غير مكتمل أو فاشل بعد 60 دقيقة.
`abandoned_checkout.recovered`	يكمل العميل الدفع عبر رابط Recovery.

للاطلاع على مخططات الحمولة التفصيلية وأوصاف الحقول وأمثلة المعالجات، راجع Webhooks الخاصة بـ Recovery.

أحداث Dunning

الحدث	يتم تشغيله عندما
`dunning.started`	تبدأ محاولة Dunning لاشتراك تجاوز موعد استحقاقه أو تم وضعه قيد الانتظار أو تم إلغاؤه.
`dunning.recovered`	يحدّث العميل طريقة الدفع الخاصة به وتنجح الرسوم الناتجة.

للاطلاع على مخططات الحمولة التفصيلية وأوصاف الحقول وأمثلة المعالجات، راجع Webhooks الخاصة بـ Recovery.

أحداث Payout

تتتبّع أحداث Payout انتقال أموالك من Dodo Payments إلى حسابك المصرفي. وهي تعكس حالات Payout المعروضة في لوحة التحكم. الحمولة عبارة عن كائن Payout له البنية نفسها كإدخال من GET /payouts.

الحدث	يتم تشغيله عندما
`payout.created`	يتم إنشاء Payout، إما بواسطة دورة Payout التلقائية أو خارج الدورة.
`payout.in_progress`	يحين تاريخ استحقاق Payout وتبدأ المعالجة.
`payout.on_hold`	يتم إيقاف Payout مؤقتًا أو وضعه قيد المراجعة.
`payout.success`	تتم تسوية Payout إلى حسابك المصرفي.
`payout.failed`	تفشل Payout. تتم إعادة قيد الأموال والرسوم إلى محفظتك.

أحداث Payout ليست نهائية ولا مرتبة ترتيبًا صارمًا. يمكن أن يصل payout.failed بعد payout.success عندما يعيد بنك ما التحويل، كما يمكن أن يصل payout.success بعد payout.failed عند استرداد Payout فاشلة لاحقًا. يتطابق status في الحمولة دائمًا مع نوع الحدث، لذا استخدم timestamp الموجود في المستوى الأعلى لكل حدث للعثور على أحدث حالة.

كان يتم إصدار payout.created سابقًا باسم payout.not_initiated. إذا كانت نقطة نهاية موجودة تستخدم عامل تصفية يستند إلى payout.not_initiated، فحدّث عامل التصفية إلى payout.created لكي يستمر في المطابقة.

للاطلاع على مخططات الحمولة التفصيلية وأوصاف الحقول وأمثلة المعالجات، راجع Webhooks الخاصة بـ Payout.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

أحداث الدفع

أحداث Refund

أحداث Dispute

أحداث Subscription

أحداث License Key

أحداث Entitlement Grant

أحداث Credit

أحداث Recovery

أحداث Dunning

أحداث Payout

​أحداث الدفع

​أحداث Refund

​أحداث Dispute

​أحداث Subscription

​أحداث License Key

​أحداث Entitlement Grant

​أحداث Credit

​أحداث Recovery

​أحداث Dunning

​أحداث Payout

أحداث الدفع

أحداث Refund

أحداث Dispute

أحداث Subscription

أحداث License Key

أحداث Entitlement Grant

أحداث Credit

أحداث Recovery

أحداث Dunning

أحداث Payout