Webhook untuk platform API chat

Dengan webhook, API aplikasi mengirimkan notifikasi real-time ke aplikasi Anda setiap kali peristiwa yang relevan terjadi selama sesi chat—misalnya, saat chat dibuat, pesan diterima, atau chat dialihkan atau ditingkatkan. Gunakan webhook untuk bereaksi terhadap aktivitas chat saat terjadi, bukan melakukan polling API.

Webhook dicakup ke sesi chat di Apps API. Contact Center AI Platform mengirimkan semua peristiwa webhook chat API aplikasi yang didukung sebagai permintaan HTTP POST ke satu URL webhook yang Anda konfigurasi. Tidak ada langganan per peristiwa.

Sebelum memulai

  • Anda harus menjadi administrator (atau memiliki peran dengan izin untuk mengedit Setelan Developer) guna mengonfigurasi webhook.
  • Siapkan endpoint yang dapat menerima permintaan POST HTTP. URL webhook harus menggunakan HTTPS.

Mengaktifkan webhook

Saat Anda mengaktifkan webhook, Contact Center AI Platform akan mengirimkan peristiwa webhook ke URL yang dikonfigurasi dan kolom URL serta secret akan muncul. Jika webhook dinonaktifkan, tidak ada peristiwa yang dikirim.

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 Webhooks, lalu klik tombol Webhooks ke posisi aktif.

Mengonfigurasi URL webhook

  1. Di URL, masukkan endpoint webhook Anda.
  2. Konfirmasi bahwa endpoint menggunakan HTTPS dan dapat menerima permintaan POST. Contact Center AI Platform mengirimkan semua peristiwa yang didukung ke satu URL ini.

Membuat secret penandatanganan

Contact Center AI Platform menandatangani setiap permintaan webhook sehingga aplikasi Anda dapat mengonfirmasi bahwa permintaan berasal dari Contact Center AI Platform. API ini mengirimkan tanda tangan di header permintaan X-Signature, dan stempel waktu penandatanganan di X-Signature-Timestamp. Anda dapat mengonfigurasi hingga dua rahasia penandatanganan:

  • Secret utama: Token utama yang digunakan untuk menandatangani permintaan webhook.
  • Rahasia sekunder: Token kedua opsional. Jika rahasia sekunder ditetapkan, Contact Center AI Platform akan menandatangani setiap permintaan dengan kedua rahasia, sehingga Anda dapat mengganti rahasia tanpa kehilangan peristiwa.

Buat setiap rahasia secara terpisah. Untuk membuat rahasia, 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.
  3. Di bagian Primary Secret, klik Generate. Klik Salin untuk menyalin rahasia dan menyimpannya dengan aman. Rahasia lengkap hanya ditampilkan tepat setelah Anda membuatnya. Setelah itu, informasi tersebut disamarkan.
  4. Opsional: Di bagian Secondary Secret, klik Generate. Klik Salin untuk menyalin rahasia dan menyimpannya dengan aman.
  5. Konfirmasi di dialog peringatan. Secret baru akan langsung diterapkan, sehingga apa pun yang masih menggunakan secret yang diganti akan gagal.

Merotasi secret penandatanganan

Jika secret utama ada, tindakan Rotate Secrets akan tersedia. Merotasi rahasia Anda secara berkala adalah praktik terbaik keamanan. Karena Contact Center AI Platform menandatangani setiap permintaan dengan secret utama dan sekunder, Anda dapat melakukan rotasi tanpa mengganggu penayangan:

  1. Di portal Platform CCAI, klik Setelan > Setelan Developer. Jika Anda tidak melihat menu Setelan, klik Menu.
  2. Pastikan rahasia primer dan sekunder telah ditetapkan.
  3. Klik Rotate Secrets untuk menukar secret primer dan sekunder.
  4. Perbarui aplikasi Anda untuk memverifikasi tanda tangan terhadap secret aktif baru. Selama periode tumpang-tindih, Contact Center AI Platform menandatangani setiap permintaan dengan kedua secret yang dikonfigurasi, sehingga menerima salah satunya dan pengiriman tidak terganggu.

Menyimpan konfigurasi Anda

Pilih Simpan untuk menerapkan status dan URL webhook yang diaktifkan. Pembuatan atau rotasi rahasia akan langsung berlaku dan tidak memerlukan operasi penyimpanan. Contact Center AI Platform mulai mengirimkan peristiwa setelah webhook diaktifkan, serta URL webhook dan secret utama ditetapkan.

Yang diterima aplikasi Anda

Setelah Anda mengaktifkan webhook, Contact Center AI Platform akan mengirimkan permintaan HTTP POST untuk setiap peristiwa chat yang didukung, seperti perubahan siklus proses, aktivitas peserta, pesan, transfer, eskalasi, formulir web, dan peringatan penutupan. Setiap isi permintaan adalah envelope JSON dengan event_type, timestamp, chat_id, dan body khusus acara.