Webhook untuk platform API chat

Webhook menyediakan cara bagi aplikasi eksternal untuk menerima notifikasi real-time saat peristiwa tertentu terjadi di platform.

Untuk menggunakan webhook, Anda harus mengaktifkannya dan membuat token. Dengan menggunakan dua secret terpisah untuk satu URL webhook, Anda menambahkan lapisan keamanan ekstra. Jika satu rahasia disusupi atau perlu dirotasi karena alasan apa pun, Anda dapat memperbarui dan merotasi rahasia tanpa mengganggu layanan webhook atau membahayakan keamanan data.

Mengaktifkan webhook

Untuk mengaktifkan webhook, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Buka panel Webhook, lalu klik tombol Webhook ke posisi aktif.

  3. Untuk URL, masukkan URL webhook. URL ini adalah endpoint yang menerima notifikasi real-time. Pastikan webhook ini dapat menerima permintaan HTTP.

  4. Klik Generate. Tindakan ini akan membuat rahasia utama, yang merupakan token keamanan utama yang digunakan untuk mengautentikasi dan memvalidasi payload webhook yang masuk. Token ini berfungsi sebagai cara utama untuk mengamankan komunikasi webhook.

  5. Salin dan simpan token di tempat yang aman.

  6. Buat secret sekunder. Secret sekunder berfungsi sebagai token keamanan cadangan atau failover. Fitur ini disediakan sebagai langkah keamanan tambahan untuk meningkatkan keandalan dan ketersediaan notifikasi webhook. Jika karena alasan apa pun, secret utama disusupi atau jika ada masalah dengan penggunaannya, secret sekunder dapat mengambil alih dan terus memastikan komunikasi.

  7. Salin dan simpan token di tempat yang aman.

  8. Klik Simpan.

Merotasi secret

Sebagai praktik terbaik keamanan, rotasikan rahasia Webhook secara berkala. Proses ini melibatkan pembuatan kunci rahasia baru untuk webhook primer dan sekunder, serta memperbaruinya di aplikasi Anda agar dapat terus menerima notifikasi dengan lancar.

Setelah penyiapan awal untuk webhook, Anda tidak dapat membuat rahasia utama baru secara langsung, tetapi Anda dapat membuat rahasia sekunder baru dan mengganti rahasia untuk mengubahnya.

Untuk merotasi secret, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Klik Rotate Secrets

  3. Klik Simpan.

Membuat secret baru

Untuk merotasi rahasia sehingga Anda memiliki dua kunci rahasia baru, ikuti langkah-langkah berikut:

  1. Di portal Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.

  2. Klik Buat untuk membuat secret sekunder baru.

  3. Klik Rotate Secrets untuk menjadikan secret sekunder baru sebagai secret utama.

  4. Klik Generate untuk membuat secret sekunder baru kedua yang akan menggantikan secret utama lama.

  5. Klik Simpan.