نظرة عامة
الويبهوك نقطة HTTPS تستضيفها أنت. يرسل عون كير إليها حدث JSON موقّعًا كلما وقع حدث مشترَك فيه.
استخدم الويبهوك لمزامنة التذاكر مع أنظمتك، أو إطلاق سير عمل، أو التنبيه للمحادثات الجديدة، أو تغذية مستودع بيانات — دون استطلاع الواجهة.
إدارة النقاط
أنشئ وأدِر النقاط من كونسول المطورين (أو عبر واجهة REST). لكل نقطة عنوان، ومجموعة أحداث مشترَك فيها، وسر توقيع خاص بها.
احفظ سر التوقيع
كتالوج الأحداث
الأحداث التي يمكنك اشتراك نقطة فيها.
| الحدث | الوصف |
|---|---|
conversation.created | بدأت محادثة جديدة (من الودجت أو قناة تكامل). |
message.created | أُرسلت رسالة في محادثة (واردة أو صادرة). |
ticket.created | تم إنشاء تذكرة دعم جديدة. |
ticket.status_changed | انتقلت التذكرة إلى حالة جديدة. |
ticket.comment_created | أُضيف رد عام على تذكرة (تُستثنى الملاحظات الداخلية). |
csat.received | قدّم العميل تقييماً للرضا. |
غلاف الحدث
لكل تسليم الغلاف نفسه: معرّف تسليم ثابت، واسم الحدث، وطابع زمني، وبيانات الحدث.
ترافق كل تسليم ترويستان — اسم الحدث والتوقيع.
التحقق من التواقيع
تحقّق دائمًا من التوقيع قبل الوثوق بأي حمولة.
ترويسة X-AwnCare-Signature بالصيغة t=TIMESTAMP,v1=SIGNATURE. احسب HMAC-SHA256 على النص المكوّن من الطابع الزمني ثم نقطة ثم جسم الطلب الخام (أي TIMESTAMP.RAWBODY) باستخدام سر نقطتك، وقارنه بـ v1 بزمن ثابت. تحقّق دائمًا من جسم الطلب الخام قبل تحليل JSON.
Node.js (Express + crypto)
PHP (hash_hmac)
إعادة المحاولة والإخفاقات
التسليم مرة واحدة على الأقل. تُعاد محاولة التسليمات الفاشلة بتباطؤ.
- جدول التباطؤ بعد كل محاولة فاشلة: دقيقة واحدة، ثم 5 دقائق، ثم 30 دقيقة.
- حتى 4 محاولات إجمالًا (1 أولية + 3 إعادات) قبل التخلي عن التسليم.
- تُعطَّل تلقائيًا أي نقطة تبلغ 10 إخفاقات متتالية.
- تُعيد المحاولات إرسال جسم مطابق بايتًا ببايت بالمعرّف نفسه، فيمكنك إزالة التكرار به.
أفضل الممارسات
بضع قواعد تُبقي تكاملك متينًا مع إعادة المحاولة وعند التوسع.
كن مُعادًا بأمان
قد يصل الحدث نفسه أكثر من مرة. أزِل التكرار باستخدام معرّف الغلاف.
أقرّ بالاستلام بسرعة
أعِد 2xx فورًا ونفّذ العمل الثقيل لاحقًا؛ الاستجابات البطيئة تُحتسب إخفاقًا وتُطلق إعادة المحاولة.
تحقّق ثم حلّل
افحص التوقيع مقابل الجسم الخام قبل تحليل JSON أو التصرف بناءً على الحدث.
استخدم HTTPS
يجب أن تكون النقاط عبر HTTPS في الإنتاج لتبقى الحمولات والتواقيع سرّية أثناء النقل.