Skip to main content

Webhook grup

Webhook ini memungkinkan aplikasi menerima notifikasi terkait aktivitas grup, seperti anggota yang bergabung, keluar, atau perubahan informasi grup. Dengan webhook, aplikasi dapat merespons perubahan grup secara otomatis.

Kategori Webhook​

Tiga kategori webhook untuk grup:

  • group_join: Notifikasi saat anggota baru bergabung ke grup
  • group_leave: Notifikasi saat anggota keluar dari grup
  • group_update: Notifikasi saat informasi grup diubah, seperti nama, foto, atau deskripsi

Group Join​

Webhook akan kirim ketika ada member yang bergabung di grup.

{
  "type": "group_join", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event group_join
    "apiKey": "xxxxx", // Alamat API Key dari device 
    "join": { // object join
      "id": "[email protected]", // id group
      "participants": [ // data list member yang bergabung
        "[email protected]"
      ],
      "action": "add" // object aksi menambahkan
    }
  }
}

Group Leave​

Webhook akan kirim ketika ada member yang keluar di grup.

{
  "type": "group_leave", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event group_leave
    "apiKey": "xxxxx", // Alamat API Key dari device 
    "leave": { // object leave
      "id": "[email protected]", // id group
      "participants": [ // data list member yang keluar
        "[email protected]"
      ],
      "action": "remove" // object aksi menambahkan
    }
  }
}

Group Update​

Webhook akan kirim ketika ada perubahan settingan/informasi grup

{
  "type": "group_update", // Tipe webhook yang dikirim
  "results": { // Kumpulan object dari event group_update
    "apiKey": "xxxxx", // Alamat API Key dari device 
    "update": [ // object update grup
      {
        "id": "[email protected]", // id group
        "announce": false // Ada 3 object, announce || subject || restrict
      }
    ]
  }
}

Struktur dari webhook json group_update seperti contoh diatas, kami akan jelaskan beberapa object tertentu :

Pada object update, ada 3 jenis yaitu announce, subject, restrict. Dari ketiga object diatas akan dijelaskan sebagai berikut :

  • Announce = Settingan untuk membuat grup hanya admin saja yang bisa chat
  • Subject = Judul grup diganti
  • Restrict = Privilege yang diatur/diganti

Use Case​

  • Memantau anggota grup untuk keperluan administrasi atau moderasi
  • Mengirim notifikasi internal saat ada anggota yang keluar atau bergabung
  • Memperbarui database internal saat terjadi perubahan informasi grup

Catatan Teknis​

  • Endpoint webhook harus menerima request POST dengan payload JSON
  • Pastikan autentikasi API valid dan perangkat aktif
  • Tangani ketiga kategori webhook secara terpisah sesuai kebutuhan aplikasi

Kesimpulan​

Webhook Grup membantu aplikasi memantau aktivitas dan perubahan grup secara real-time. Dengan informasi yang diterima, sistem dapat mengeksekusi respons otomatis, menjaga administrasi grup tetap efisien dan akurat.