Webhook status koneksi perangkat
Webhook ini digunakan untuk memantau status koneksi perangkat yang terhubung ke aplikasi. Dengan webhook, Anda dapat memastikan perangkat selalu siap untuk mengkonsumsi API secara real-time.
Fungsi Webhook
- Memberikan notifikasi saat perangkat terhubung atau siap digunakan
- Memonitor status koneksi secara real-time
- Memastikan integrasi API berjalan lancar
Ada 3 kategori webhook yang akan dikirim :
- ready
- change_state
- disconnected
Ready
Event ini menandakan perangkat berhasil terhubung ke aplikasi dan siap untuk digunakan.
{
"type": "ready", // Tipe webhook yang dikirim
"results": { // Kumpulan object dari event ready
"apiKey": "xxxxx", // API Key yang mewakili device
"message": "Device connected successfully" // Pesan koneksi berhasil
}
}
Dengan event ready, sistem dapat mulai mengirim dan menerima pesan atau media secara otomatis.
Change State
Event webhook dengan type change_state akan dikirim ketika ada perubahan status koneksi pada aplikasi/device.
{
"type": "change_state", // Tipe webhook yang dikirim
"results": { // Kumpulan object dari event change_state
"apiKey": "xxxxx", // API Key yang mewakili device
"state": "SERVICE_SCAN" // Status perubahan koneksi
}
}
Pada object state ada beberapa nilai :
| State | Keterangan |
|---|---|
| CONNECTED | Perangkat berhasil terhubung ke aplikasi |
| SERVICE_SCAN | Aplikasi menunggu perangkat untuk di scan, buka aplikasi whatsapp pada perangkat hp/emulator Anda. Scan qrcode pada aplikasi. |
| SERVICE_OFF | Layanan mati |
| PAIRING | Perangkat sedang mencoba terhubung ke aplikasi |
Disconnected
Event webhook dengan type disconnected akan dikirim ketika aplikasi dan perangkat terputus.
{
"type": "disconnected", // Tipe webhook yang dikirim
"results": { // Kumpulan object dari event disconnected
"apiKey": "xxxxx", // API Key yang mewakili device
"state": "SERVICE_OFF", // Status perubahan koneksi
"reason": "connection_logout", // Penyebab perangkat terputus dengan aplikasi
"reconnect": false // Boolean apakah aplikasi bisa reconnect lagi / tidak
}
}
Pada object reason ada beberapa nilai :
| Reason | Keterangan |
|---|---|
| bad_session | Sesi whatsapp telah kadaluarsa atau tidak valid |
| connection_closed | Koneksi ke whatsapp ke web tertutup |
| connection_lost | Koneksi whatsapp web hilang |
| connection_conflict | Koneksi aplikasi diganti |
| connection_logout | Koneksi ke whatsapp web logout, harus scan ulang |
| not_multidevice | Aplikasi whatsapp tidak mendukung multidevice |
| connection_reconnect | Whatsapp web sedang mencoba menghubungkan ulang |
| connection_timedout | Koneksi berakhir |
| connection_banned | Perangkat / no whatsapp dibanned |
| connection_banned_temp | Whatsapp web sedang dibanned sementara |
Untuk object reconnect, jika nilainya true, ketika Anda Service Start, akan langsung terhubung/connected, sebaliknya, jika false, Anda wajib scan ulang perangkat.
Use Case
- Mengetahui kapan perangkat sudah siap menerima pesan otomatis
- Memulai proses sinkronisasi atau pengiriman pesan terjadwal begitu perangkat online
- Memantau beberapa perangkat secara bersamaan agar layanan tetap stabil
Catatan Teknis
- Memerlukan endpoint webhook yang valid dan dapat menerima request POST
- Pastikan autentikasi API aktif agar event ready diterima
- Gunakan sistem monitoring tambahan jika perangkat memiliki banyak sesi
Kesimpulan
Webhook status koneksi perangkat membantu memastikan semua perangkat terhubung dan siap digunakan. Dengan notifikasi real-time, integrasi API menjadi lebih efisien dan responsif.