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

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

مخطط الحمولة

الحقل	النوع	الوصف
`processId`	`string` (UUID)	معرّف المعاملة.
`state`	`string`	الحالة الحالية للمعاملة. حالياً: `PROCESS_STATE_FINISHED`.
`result`	`string`	نتيجة العملية المنتهية. موجود عندما تكون `state=PROCESS_STATE_FINISHED`. القيم المحتملة: `ok`، `expired`، `invalid_identity`.
`flow`	`string`	التدفق الذي نُفِّذ لهذه المعاملة (مثل: `id`، `idtoken`).
`lastEvent`	`string`	آخر حدث في المعاملة. يُعاد فقط عندما تكون `result=expired`.
`lastEventDescription`	`string`	وصف مقروء للإنسان لـ `lastEvent`. يُعاد فقط عندما تكون `result=expired`.

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

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

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

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

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

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

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

تعداد lastEvent

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

الحدث	الوصف
`EVENT_TYPE_PROCESS_CREATED`	تم إنشاء العملية
`EVENT_TYPE_QR_CODE_READ`	تمت قراءة رمز QR
`EVENT_TYPE_PROCESS_STARTED_BY_USER`	بدأ المستخدم العملية
`EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED`	اكتملت خطوة التحقق من الهوية
`EVENT_TYPE_DOCUMENT_STEP_STARTED`	بدأت خطوة المستند
`EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED`	تم التقاط صورة المستند
`EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY`	تم رفع المستند من المعرض
`EVENT_TYPE_DOCUMENT_STEP_FINISHED`	اكتملت خطوة المستند
`EVENT_TYPE_SESSION_ENDED`	انتهت الجلسة بسبب انتهاء المهلة أو إنشاء جلسة جديدة
`EVENT_TYPE_ERROR_ON_DOCUMENT_STEP`	خطأ في خطوة المستند

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

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

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

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

لتدفقات المرئي / الويب والأجهزة الأصلية: انظر مرجع API > الويب والأجهزة الأصلية > GET /v1/process/{id}.
لتدفقات غير المرئي / API: انظر مرجع API > API > GET /processes/v1/{id}.

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

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

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

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

تعداد lastEvent​

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