تخطَّ إلى المحتوى

كتالوج الأحداث

شكل الحمولة

Section titled “شكل الحمولة”

كل حدث كائن JSON واحد:

{
  "id": "evt_01HKQN9…",
  "type": "conversation.created",
  "occurred_at": "2026-04-20T14:23:45.123Z",
  "account_id": "7c1d2c6e-…",
  "site_id": "0f3a…",
  "data": { … the resource, in the same shape the API returns it … }
}

id هي القيمة الموجودة في الترويسة X-RolChat-Event-Id وهي ثابتة عبر إعادات المحاولة. type بصيغة <domain>.<noun>.<verb> أو <domain>.<verb> في snake_case. يحمل data المورد كما كانت ستُعيده نقطة النهاية GET المقابلة، فيمكن كتابة المستقبِل وفق مرجع API دون الحاجة إلى مخطط ثانٍ أبدًا.

عائلات الأحداث

Section titled “عائلات الأحداث”
العائلة أمثلة تُرسل عندما
conversation.* conversation.created، conversation.assigned، conversation.resolved، conversation.reopened، conversation.merged تتغير حالة محادثة أو ملكيتها
message.* message.created، message.delivered، message.read، message.failed تُنشر رسالة أو تتغير حالة تسليمها
crm.* crm.lead.created، crm.contact.created، crm.contact.updated، crm.contact.merged، crm.deal.stage_changed، crm.deal.won يتغير عميل محتمل أو جهة اتصال أو شركة أو صفقة
ticket.* ticket.created، ticket.status_changed، ticket.assigned، ticket.sla_breached تتغير تذكرة
visitor.* visitor.identified، visitor.cobrowse.requested يُعرَّف زائر أو يطلب جلسة تصفح مشترك
marketing.* marketing.form.submitted، marketing.booking.created، marketing.campaign.sent، marketing.unsubscribed النماذج، والحجوزات، والحملات
kb.* kb.article.published، kb.article.unpublished تغييرات قاعدة المعرفة
phone.* phone.call.started، phone.call.ended، phone.call.recorded، phone.call.transcribed، phone.voicemail.received المكالمات والبريد الصوتي
automation.* automation.rule.executed، automation.rule.failed تُنفَّذ قاعدة أتمتة
privacy.* privacy.consent.granted، privacy.consent.withdrawn، privacy.dsr.received الموافقة وطلبات أصحاب البيانات
billing.* billing.invoice.created، billing.trial_expiring، billing.subscription.changed الاشتراك والفواتير
auth.* auth.api_key.created، auth.api_key.revoked، auth.account.swapped أحداث الحساب ذات الصلة بالأمان
ai.* ai.usage.recorded كل استدعاء لمحوّل ذكاء اصطناعي، مع أعداد الرموز

تنمو القائمة الدقيقة مع المنتج؛ وتعرض شاشة الاشتراك كل نوع يستطيع حسابك تلقيه وتتيح التصفية لكل نوع.

الاشتراك

Section titled “الاشتراك”

تتبع اشتراكات webhook إضافةً ما. في الإعدادات ← الإضافات، افتح الإضافة (أو أنشئ إضافة مخصصة) وأضف نقطة نهاية: عنوان URL بصيغة HTTPS، وأنواع الأحداث التي تريدها، وقائمة سماح IP اختيارية. يُعرض سر التوقيع مرة واحدة. تظهر عمليات التسليم وإعادات المحاولة والرسائل الميتة لنقطة النهاية تلك في سجل Webhook الخاص بالإضافة.

يصف Plugin Protocol في صفحة الإضافات كيف تعلن الإضافة عن الأحداث التي تحتاجها في بيانها.

الترتيب والتسليم

Section titled “الترتيب والتسليم”
  • التسليم مرة واحدة على الأقل. أزل التكرار حسب id.
  • تُرسل أحداث المورد الواحد بالترتيب، لكن إعادات المحاولة قد تغيّر ترتيب عمليات التسليم. استخدم occurred_at وupdated_at الخاص بالمورد بدلًا من وقت الوصول.
  • الاشتراك الذي يواصل الفشل يراكم رسائل ميتة؛ وأكثر من 100 لنقطة نهاية واحدة يطلق تنبيهًا لدى RolChat ويعرض تحذيرًا في سجل الإضافة.