أنواع الأحداث

تصف حمولات Webhook انتقال حالة العملية. تُوثّق هذه الصفحة مخطط الحمولة والتعداد الكامل لقيم lastEvent.

مخطط الحمولة

الحقل	النوع	الوصف
`processId`	`string` (UUID)	معرّف المعاملة.
`state`	`string`	الحالة الحالية للمعاملة. حالياً: `PROCESS_STATE_FINISHED`.
`flow`	`string`	التدفق الذي نُفِّذ لهذه المعاملة (مثل: `api+humantoken`، `api+liveness+humantoken`، `humantoken`, `humantoken+revalidation`, `api+liveness+humantoken+revalidation`).
`lastEvent`	`string`	آخر حدث في المعاملة. يُعاد فقط عندما تنتهي صلاحية العملية قبل أن يُكمل المستخدم التدفق.
`lastEventDescription`	`string`	وصف مقروء للإنسان لـ `lastEvent`. يُعاد فقط عندما تنتهي صلاحية العملية قبل أن يُكمل المستخدم التدفق.

مفردات الحالة

يستخدم حقل state في حمولات Webhook البادئة PROCESS_STATE_*. هذه مفردات مستقلة عن حقلَي result وstatus اللذَين تُعيدهما نقطة نهاية GetProcess، واللذان يستخدمان PROCESS_RESULT_*. لا تعامل هذه المفردات على أنها قابلة للتبادل.

مثال على الحمولة

منتهية — ناجحة

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "humantoken"
}

منتهية — منتهية الصلاحية

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "humantoken",
  "lastEvent": "EVENT_TYPE_SESSION_ENDED",
  "lastEventDescription": "Session ended by timeout or by new session created"
}

تعداد lastEvent

القائمة الكاملة للقيم التي قد تظهر في lastEvent:

الحدث	الوصف
`EVENT_TYPE_PROCESS_CREATED`	تم إنشاء العملية
`EVENT_TYPE_PROCESS_STARTED_BY_USER`	بدأ المستخدم العملية
`EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED`	اكتملت خطوة التحقق من الهوية
`EVENT_TYPE_SESSION_ENDED`	انتهت الجلسة بسبب انتهاء المهلة أو إنشاء جلسة جديدة

معالجة قابلة للتهيئة

قد تتطور مجموعة الأحداث. تعامل مع الأحداث التي يتفاعل معها endpoint الخاص بك باعتبارها إعداداً، لا ثوابت مُضمَّنة في الكود — بهذه الطريقة يمكن تفعيل أحداث جديدة دون نشر جديد.

قراءة النتيجة الكاملة للعملية

تُشير حمولة Webhook إلى اكتمال العملية، لكنها لا تتضمن النتيجة نفسها. لاسترداد النتيجة — إلى جانب بيانات الالتقاط، ونتائج القياس الحيوي، وحقول المستند، وما إلى ذلك — استدعِ نقطة النهاية المناسبة GetProcess انظر الحصول على العملية.

مخطط الحمولة​

مثال على الحمولة​

منتهية — ناجحة​

منتهية — منتهية الصلاحية​

تعداد lastEvent​

قراءة النتيجة الكاملة للعملية​