Webhook Status Koneksi Perangkat

Webhook status koneksi perangkat mengirimkan notifikasi otomatis ke server setiap kali status koneksi perangkat WhatsApp berubah, seperti terhubung, terputus, atau menunggu scan QR.

Ada tiga tipe event dalam kategori ini: ready saat perangkat siap, change_state saat status berubah, dan disconnected saat koneksi terputus beserta informasi penyebabnya.

Prasyarat

• Webhook sudah dikonfigurasi dan tipe event koneksi sudah diaktifkan di dashboard.

Panduan konfigurasi di Integrasi Notifikasi Webhook.

Event: ready

Dikirim saat perangkat berhasil terhubung ke aplikasi dan siap menerima atau mengirim pesan.

{
  "type": "ready",
  "results": {
    "apiKey": "xxxxx",
    "message": "Device connected successfully"
  }
}

Field	Keterangan
type	Selalu bernilai ready
results.apiKey	API Key dari perangkat yang terhubung
results.message	Pesan konfirmasi koneksi berhasil

Event: change_state

Dikirim setiap kali status koneksi perangkat berubah.

{
  "type": "change_state",
  "results": {
    "apiKey": "xxxxx",
    "state": "SERVICE_SCAN"
  }
}

Nilai yang mungkin untuk field state:

State	Keterangan
CONNECTED	Perangkat berhasil terhubung ke aplikasi
SERVICE_SCAN	Aplikasi menunggu scan QR code
SERVICE_OFF	Layanan mati
PAIRING	Perangkat sedang dalam proses koneksi

Event: disconnected

Dikirim saat perangkat terputus dari sistem beserta informasi penyebab putusnya koneksi.

{
  "type": "disconnected",
  "results": {
    "apiKey": "xxxxx",
    "state": "SERVICE_OFF",
    "reason": "connection_logout",
    "reconnect": false
  }
}

Nilai yang mungkin untuk field reason:

Reason	Keterangan
bad_session	Sesi WhatsApp sudah kedaluwarsa atau tidak valid
connection_closed	Koneksi ke WhatsApp Web tertutup
connection_lost	Koneksi WhatsApp Web hilang
connection_conflict	Koneksi digantikan oleh sesi lain
connection_logout	Logout dari WhatsApp Web — perlu scan QR ulang
not_multidevice	Aplikasi WhatsApp tidak mendukung multi-device
connection_reconnect	WhatsApp Web sedang mencoba menghubungkan ulang
connection_timedout	Koneksi berakhir karena timeout
connection_banned	Nomor WhatsApp atau perangkat dibanned
connection_banned_temp	Nomor dibanned sementara oleh WhatsApp

Field reconnect:

• true : saat Service Start dijalankan, perangkat langsung terhubung kembali tanpa scan QR
• false : perangkat harus scan QR ulang sebelum bisa terhubung