QwikChat API Docs

Notifikasi di Situs Anda

Tampilkan notifikasi saluran Siaran di situs Anda sendiri, dan kirim notifikasi yang berbeda untuk tiap pengguna lewat API.

Cocok untuk hal-hal yang terjadi pada satu orang: "Pesanan #1204 dikemas", "Pembayaran diterima", "Poin bertambah 50". Setiap pembaca hanya melihat notifikasi yang memang ditujukan kepadanya.

1. Buat saluran Siaran

Buka Perangkat, pilih Tambah Perangkat, lalu saluran Siaran. Saluran ini tidak memakai nomor telepon dan tidak memotong kuota pesan.

2. Tempel potongan kode

Pada perangkat tersebut klik Sambungkan, lalu salin salah satu potongan kode. Yang pertama menampilkan daftar notifikasi di dalam elemen yang Anda tentukan:

<div id="qc-notif"></div>
<script src="https://qwikchat.app/public/notify.js"
        data-qwikchat="wk_xxxxxxxxxxxxxxxxxxxx"
        data-mount="qc-notif" data-mode="inline" async></script>

Yang kedua menampilkan ikon lonceng dengan penanda jumlah yang belum dibaca — biasanya diletakkan di bilah atas situs Anda:

<div id="qc-bell"></div>
<script src="https://qwikchat.app/public/notify.js"
        data-qwikchat="wk_xxxxxxxxxxxxxxxxxxxx"
        data-mount="qc-bell" data-mode="bell" async></script>
Elemen tujuan (data-mount) wajib ada. Jika elemen itu tidak ditemukan, tidak ada yang ditampilkan sama sekali — notifikasi tidak akan pindah sendiri ke tempat lain di halaman Anda.

3. Daftarkan alamat situs Anda

Pada panel yang sama, isi Alamat situs yang diizinkan — satu alamat per baris. Selama daftar ini kosong, notifikasi tidak muncul di mana pun. Pembatasan inilah yang mencegah orang lain menempelkan potongan kode Anda di situsnya.

4. Pembaca menghubungkan akunnya

Pembaca notifikasi adalah pemilik akun QwikChat. Saat pertama kali membuka halaman Anda, mereka melihat tombol Hubungkan akun QwikChat. Tombol itu membuka jendela kecil di QwikChat, tempat mereka masuk dan menyetujui — sekali saja per peramban.

Ini bukan langkah tambahan yang bisa dihilangkan. Cookie sesi QwikChat tidak pernah ikut terkirim ke bingkai di situs lain (SameSite=Lax), jadi tanpa persetujuan itu kami tidak punya cara apa pun untuk tahu siapa yang sedang membaca.

Setelah menyetujui, halaman Anda menerima peristiwa qwikchat:connected berisi alamat email atau nomor akun QwikChat pembaca. Simpan alamat itu di sistem Anda — itulah yang dipakai untuk mengirim notifikasi kepadanya.

document.addEventListener('qwikchat:connected', function (e) {
  fetch('/simpan-alamat-qwikchat', {
    method: 'POST',
    body: JSON.stringify({ alamat: e.detail.address }),
  });
});

5. Kirim notifikasi dari server Anda

Panggil endpoint berikut dari backend Anda. Otentikasi memakai API key perangkat pada header Authorization, tanpa awalan Bearer — sama seperti endpoint API lainnya.

POST/api/v1/client/notify
{
  "to": "budi@example.com",
  "title": "Pesanan #1204 dikemas",
  "body": "Kurir menjemput sore ini.",
  "link": "https://tokoanda.com/pesanan/1204"
}

to diisi email atau nomor telepon akun QwikChat penerima. Untuk mengirim ke satu segmen sekaligus, ganti to dengan label berisi nama label pelanggan — bukan keduanya.

title dan body boleh salah satu saja; link opsional dan harus http atau https.

Kuota

Notifikasi lewat API tidak memotong kuota siaran bulanan. Jumlahnya mengikuti aktivitas bisnis Anda, bukan keputusan yang Anda ambil satu per satu, jadi yang berlaku hanya batas kecepatan permintaan. Kuota 5.000 siaran per bulan tetap berlaku untuk siaran yang Anda tulis sendiri di halaman Siaran.

Mencabut akses

Pemilik akun bisa memutus sebuah situs kapan saja lewat Pengaturan → Situs terhubung. Dari sisi Anda, tombol Ganti kunci pada panel perangkat mengganti kunci embed sekaligus memutus semua situs yang sudah terhubung — potongan kode di situs Anda harus diperbarui setelahnya.