Jenis event
Payload webhook mendeskripsikan transisi status suatu proses. Halaman ini mendokumentasikan skema payload dan enumerasi lengkap nilai lastEvent.
Skema payload
| Field | Type | Deskripsi |
|---|---|---|
processId | string (UUID) | ID transaksi. |
state | string | Status terkini transaksi. Saat ini: PROCESS_STATE_FINISHED. |
flow | string | Flow yang dieksekusi untuk transaksi ini (misalnya, api+humantoken, api+liveness+humantoken, humantoken, humantoken+revalidation, api+liveness+humantoken+revalidation). |
lastEvent | string | Event terakhir dari transaksi. Hanya dikembalikan ketika proses kedaluwarsa sebelum pengguna menyelesaikan flow. |
lastEventDescription | string | Deskripsi lastEvent yang dapat dibaca manusia. Hanya dikembalikan ketika proses kedaluwarsa sebelum pengguna menyelesaikan flow. |
Field state dalam payload webhook menggunakan prefiks PROCESS_STATE_*. Ini adalah kosakata yang berbeda dari field result dan status yang dikembalikan oleh endpoint GetProcess, yang menggunakan PROCESS_RESULT_*. Jangan memperlakukan keduanya sebagai hal yang dapat dipertukarkan.
Contoh payload
Selesai — berhasil
{
"processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
"state": "PROCESS_STATE_FINISHED",
"flow": "humantoken"
}
Selesai — kedaluwarsa
{
"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"
}
Enumerasi lastEvent
Daftar lengkap nilai yang dapat muncul di lastEvent:
| Event | Deskripsi |
|---|---|
EVENT_TYPE_PROCESS_CREATED | Proses dibuat |
EVENT_TYPE_PROCESS_STARTED_BY_USER | Proses dimulai oleh pengguna |
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED | Langkah validasi identitas selesai |
EVENT_TYPE_SESSION_ENDED | Sesi berakhir karena timeout atau karena sesi baru dibuat |
Kumpulan event dapat berkembang. Perlakukan event yang direspons oleh endpoint Anda sebagai konfigurasi, bukan konstanta yang di-hardcode — dengan begitu event baru dapat diaktifkan tanpa perlu melakukan deploy.
Membaca hasil proses lengkap
Payload webhook menandakan bahwa proses telah selesai, tetapi tidak menyertakan hasilnya. Untuk mengambil hasil — beserta data tangkapan, skor biometrik, field dokumen, dll. — panggil endpoint GetProcess yang sesuai, lihat Dapatkan Proses.