Webhook

Webhook adalah layanan yang menghosting logika bisnis Anda atau memanggil layanan lain. Selama sesi, webhook memungkinkan Anda menggunakan data yang diekstrak oleh natural language processing Dialogflow CX untuk menghasilkan respons dinamis, memvalidasi data yang dikumpulkan, atau memicu tindakan di backend.

Webhook dapat berupa webhook standar atau webhook fleksibel. Dengan webhook standar, kolom permintaan dan respons ditentukan oleh Dialogflow CX. Dengan webhook fleksibel, Anda menentukan kolom permintaan dan respons.

Webhook standar

Dengan webhook standar, Anda menggunakan pesan permintaan dan respons yang ditentukan Dialogflow CX. Pesan permintaan memberikan banyak detail tentang sesi. Misalnya, halaman aktif saat ini, maksud yang cocok baru-baru ini, nilai parameter sesi, dan respons yang ditentukan agen semuanya disertakan.

Permintaan webhook standar

Saat pemenuhan dengan webhook dipanggil, Dialogflow CX mengirimkan permintaan webhook POST HTTPS ke layanan webhook Anda. Isi permintaan ini adalah objek JSON WebhookRequest dengan informasi tentang sesi.

Beberapa integrasi mengisi kolom WebhookRequest.payload dengan informasi tambahan. Misalnya, integrasi Gateway Telepon Dialogflow CX memberikan ID penelepon pengguna akhir.

Lihat dokumentasi referensi WebhookRequest(V3) atau WebhookRequest(V3Beta1) untuk mengetahui detailnya.

Respons webhook standar

Setelah menerima permintaan webhook, layanan webhook Anda harus mengirimkan respons webhook. Batasan berikut berlaku untuk respons Anda:

• Respons harus terjadi dalam waktu tunggu yang Anda konfigurasi saat membuat resource webhook, jika tidak, permintaan akan kehabisan waktu.
• Ukuran respons harus kurang dari atau sama dengan 64 KiB.

Lihat dokumentasi referensi WebhookResponse(V3) atau WebhookResponse(V3Beta1) untuk mengetahui detailnya.

Setelan resource webhook standar

Berikut ini deskripsi setelan resource webhook untuk webhook standar:

Istilah	Definisi
Nama tampilan	Nama yang ditampilkan di konsol untuk webhook.
Waktu tunggu webhook	Saat mengirim permintaan webhook ke layanan webhook Anda, Dialogflow CX mungkin mengalami waktu tunggu habis saat menunggu respons. Setelan ini mengontrol waktu tunggu tersebut dalam detik. Jika terjadi waktu tunggu habis, Dialogflow CX akan memanggil peristiwa webhook.error.timeout.
Jenis	Setel ke Service directory jika Anda menggunakan service directory untuk akses jaringan pribadi, atau setel ke Generic web service.
URL webhook	Berikan alamat URL untuk layanan webhook Anda.
Subjenis	Disetel ke Standar
Webhook khusus lingkungan	Anda dapat menyediakan webhook khusus lingkungan.
Autentikasi	Lihat bagian autentikasi.
Sertifikat CA kustom	Opsi ini digunakan untuk mengupload sertifikat CA kustom.

Webhook fleksibel

Dengan webhook fleksibel, Anda menentukan metode HTTP permintaan, parameter URL permintaan, dan kolom pesan permintaan dan respons. Permintaan hanya dapat memberikan nilai parameter yang dipilih, dan respons hanya dapat memberikan nilai penggantian parameter. Batasan ini sebenarnya bermanfaat, karena menyederhanakan antarmuka antara agen dan webhook. Hampir tidak ada kebutuhan untuk mengomunikasikan apa pun selain nilai parameter sesi antara agen dan webhook. Hal ini juga menyederhanakan penerapan webhook Anda, karena pesan permintaan dan respons hanya berisi apa yang Anda butuhkan, dan Anda dapat memberikan pesan webhook unik untuk berbagai skenario.

Permintaan webhook fleksibel

Saat membuat resource webhook untuk agen, Anda dapat menentukan hal berikut untuk permintaan webhook:

• Metode HTTP yang digunakan untuk permintaan webhook yang dikirim ke layanan webhook Anda.
• Nilai parameter sesi yang harus dikirim Dialogflow CX ke layanan webhook Anda menggunakan URL.
• Jika memilih POST, PUT, atau PATCH sebagai metode, Anda dapat menentukan nilai parameter sesi yang harus dikirim Dialogflow CX ke layanan webhook Anda melalui isi JSON permintaan.

Untuk mengirim nilai parameter sesi menggunakan URL permintaan atau isi JSON, gunakan referensi parameter seperti biasa. Anda tidak perlu melakukan escape URL pada referensi parameter, dan Anda tidak perlu menyertakan referensi dalam tanda petik. Saat runtime, Dialogflow CX akan meng-escape nilai parameter URL sesuai kebutuhan. Nilai daftar atau gabungan akan diberikan sebagai JSON.

Saat menggunakan referensi parameter di isi JSON, Anda harus menyertakan referensi dalam tanda petik, terlepas dari jenis parameter. Jika parameter sebenarnya adalah nilai skalar, daftar, atau komposit numerik, Dialogflow CX akan menghapus tanda petik saat mengirim permintaan saat runtime untuk mempertahankan jenis data parameter. Jenis skalar string akan tetap dalam tanda kutip. Jika nilai skalar, daftar, atau komposit numerik dirujuk dalam nilai string (misalnya: "Ini adalah angka: $session.params.size"), parameter akan diperlakukan sebagai string ("Ini adalah angka: 3").

Misalnya, Anda dapat memberikan nilai parameter sesi fruit dan size ke URL permintaan seperti ini:

https://your-webhook-service.com/handler?f=$session.params.fruit&s=$session.params.size

Dan, ke isi JSON permintaan seperti ini:

{
  "fruitParameter": "$session.params.fruit",
  "sizeParameter": "$session.params.size"
}

Respons webhook yang fleksibel

Saat membuat resource webhook untuk agen, Anda dapat menentukan parameter sesi yang harus ditetapkan Dialogflow CX ke kolom tertentu dari respons webhook saat runtime.

Batasan berikut berlaku untuk respons Anda:

• Respons harus terjadi dalam waktu tunggu yang Anda konfigurasi saat membuat resource webhook, jika tidak, permintaan akan mengalami waktu tunggu.
• Ukuran respons harus kurang dari atau sama dengan 64 KiB.

Gunakan format berikut untuk menentukan kolom skalar, daftar, atau komposit:

$.fully.qualified.path.to.field

Misalnya, perhatikan respons JSON berikut:

{
  "routes" : [
    {
      "legs" : [
        {
          "distance" : {
            "text" : "2,064 mi",
            "value" : 3321004
          }
        }
      ]
    }
  ]
}

Untuk menentukan kolom "value", gunakan yang berikut:

$.routes[0].legs[0].distance.value

Setelan resource webhook yang fleksibel

Berikut ini penjelasan setelan resource webhook untuk webhook fleksibel:

Istilah	Definisi
Nama tampilan	Nama yang ditampilkan di konsol untuk webhook.
Waktu tunggu webhook	Saat mengirim permintaan webhook ke layanan webhook Anda, Dialogflow CX mungkin mengalami waktu tunggu habis saat menunggu respons. Setelan ini mengontrol waktu tunggu tersebut dalam detik. Jika terjadi waktu tunggu habis, Dialogflow CX akan memanggil peristiwa webhook.error.timeout.
Jenis	Setel ke Service directory jika Anda menggunakan service directory untuk akses jaringan pribadi, atau setel ke Generic web service.
URL webhook	Berikan alamat URL untuk layanan webhook Anda, yang dapat mencakup referensi ke parameter sesi.
Subjenis	Disetel ke Fleksibel
Metode	Tetapkan metode HTTP untuk permintaan webhook.
Isi permintaan	Berikan isi JSON permintaan seperti yang dijelaskan di atas.
Konfigurasi respons	Berikan parameter sesi yang harus disetel ke kolom respons seperti yang dijelaskan di atas.
Webhook khusus lingkungan	Anda dapat menyediakan webhook khusus lingkungan.
Autentikasi	Lihat bagian autentikasi.
Sertifikat CA kustom	Opsi ini digunakan untuk mengupload sertifikat CA kustom.

Menggunakan template kustom standar

Dialogflow menawarkan template kustom yang telah ditentukan sebelumnya yang dapat Anda gunakan untuk mengintegrasikan webhook fleksibel dengan CRM Salesforce.

1. Di tab Manage, klik Webhooks, lalu + Create.

2. Di bagian Subtype, pilih Flexible.

3. Klik Konfigurasi menggunakan template standar untuk mengaktifkan fitur ini.

4. Di menu drop-down Integration type, pilih Salesforce.

5. Di menu drop-down API name, pilih nama API. Template akan otomatis mengisi formulir webhook berdasarkan nama API yang Anda pilih.

   1. Anda dapat mengonfigurasi kolom berikut secara manual jika berlaku, berdasarkan parameter Anda:

      • URL webhook
      • Metode
      • JSON isi permintaan
      • Konfigurasi Respons

   2. Kolom OAuth yang wajib diisi akan ditandai di bagian Authentication.

6. Klik Simpan untuk membuat webhook.

Persyaratan layanan webhook

Persyaratan berikut harus dipenuhi oleh layanan webhook Anda:

• Server harus menangani permintaan HTTPS. HTTP tidak didukung. Jika Anda menghosting layanan webhook di Google Cloud Platform menggunakan solusi Compute atau Serverless computing, lihat dokumentasi produk untuk penayangan dengan HTTPS. Untuk opsi hosting lainnya, lihat Mendapatkan sertifikat SSL untuk domain Anda.
• URL-nya untuk permintaan harus dapat diakses secara publik, kecuali jika dihosting sebagai resource Cloud Run atau diakses sebagai webhook Service Directory.
• Aplikasi ini harus menangani permintaan dan respons seperti yang dijelaskan di bagian webhook standar atau webhook fleksibel.
• Jika agen Anda tidak terintegrasi dengan Akses jaringan pribadi Service Directory, panggilan webhook dianggap berada di luar perimeter layanan dan diblokir saat mengaktifkan Kontrol Layanan VPC. Endpoint terbatas didukung oleh Service Directory; lihat Service Directory untuk mengetahui detailnya.

Autentikasi

Penting untuk mengamankan layanan webhook Anda, sehingga hanya Anda atau agen Dialogflow CX Anda yang diizinkan untuk membuat permintaan. Ini dikonfigurasi saat membuat atau mengedit resource webhook. Dialogflow CX mendukung mekanisme berikut untuk autentikasi:

Istilah	Definisi
Header autentikasi	Untuk setelan webhook, Anda dapat menentukan pasangan nilai kunci header HTTP opsional. Jika disediakan, Dialogflow CX akan menambahkan header HTTP ini ke permintaan webhook. Umumnya, satu pasangan dengan kunci authorization akan diberikan. Nilai header mendukung referensi parameter sesi dan parsing fungsi sistem seperti dalam pesan respons statis. Jika Anda menggunakan kredensial statis untuk header authorization, sebaiknya berikan kredensial Anda menggunakan Secret Manager.
Autentikasi dasar dengan nama pengguna dan sandi	Untuk setelan webhook, Anda dapat menentukan nilai nama pengguna dan sandi login opsional. Jika disediakan, Dialogflow CX akan menambahkan header HTTP otorisasi ke permintaan webhook. Header ini memiliki format: "authorization: Basic <base 64 encoding of the string username:password>". Sebaiknya berikan nama pengguna dan sandi Anda menggunakan Secret Manager.
OAuth pihak ketiga	Anda dapat menentukan konfigurasi OAuth Pihak ketiga sehingga Dialogflow CX menukar token akses dari sistem OAuth dan menambahkannya di header HTTP otorisasi. Hanya alur kredensial klien yang didukung. Sebaiknya berikan secret klien Anda menggunakan Secret Manager.
Token akses agen layanan	Dihentikan
Akun layanan	Anda dapat menggunakan akun layanan untuk autentikasi. Token ini dapat digunakan untuk mengakses Google Cloud API lainnya.
Token ID agen layanan	Anda dapat memilih token ID di Autentikasi agen layanan untuk menggunakan token ID agen layanan untuk autentikasi. Hal ini dapat digunakan untuk mengakses resource Cloud Run.
Autentikasi TLS bersama	Lihat dokumentasi Autentikasi TLS bersama.

Catatan: Jika beberapa opsi autentikasi diaktifkan, opsi dengan prioritas lebih tinggi akan diutamakan. Urutan prioritas opsi autentikasi: Header autentikasi, Autentikasi Dasar, OAuth Pihak Ketiga, Autentikasi Agen Layanan.

Catatan: Kami tidak merekomendasikan penggunaan rentang IP untuk mengautentikasi permintaan webhook. Jika Anda memilih untuk menggunakan IP sumber permintaan untuk mengaktifkan konektivitas ke perimeter jaringan, Anda harus mengizinkan permintaan dari rentang yang tercantum di https://www.gstatic.com/ipranges/goog.json, lalu menolak koneksi apa pun dari rentang yang tercantum di https://www.gstatic.com/ipranges/cloud.json (yang merupakan alamat Google yang dapat digunakan untuk men-deploy workload pihak ketiga). Selain itu, Dialogflow tidak dapat memberikan jaminan apa pun tentang rentang IP untuk mesin yang mengirim permintaan webhook.

Catatan: Setelah 15 Agustus 2025, agen yang diekspor tidak akan lagi berisi kredensial nilai mentah untuk header autentikasi, autentikasi dasar dengan nama pengguna dan sandi, serta OAuth pihak ketiga.

OAuth pihak ketiga

Dialogflow CX dapat mengumpulkan token akses dari penyedia OAuth pihak ketiga dan menambahkannya ke header HTTP otorisasi saat membuat permintaan webhook.

Berikut ini penjelasan setelan resource untuk OAuth pihak ketiga:

Istilah	Definisi
ID Klien	Client ID yang akan digunakan saat meminta token OAuth.
Rahasia Klien	Secret yang akan digunakan saat meminta token OAuth. Sebaiknya berikan secret klien Anda menggunakan Secret Manager.
URL Endpoint OAuth	URL yang akan digunakan untuk meminta token OAuth.
Cakupan OAuth	Daftar cakupan yang dipisahkan koma yang dapat digunakan untuk token OAuth.

Permintaan yang dikirim ke URL Endpoint OAuth untuk menerima token tidak menyertakan header permintaan kustom yang dikonfigurasi untuk permintaan webhook. Anda dapat meneruskan informasi kustom ke server OAuth sebagai parameter dalam string kueri URL endpoint OAuth.

Catatan: Token OAuth pihak ketiga digunakan kembali untuk permintaan webhook menggunakan client ID, URL endpoint, dan cakupan yang sama dalam agen Dialogflow CX yang sama selama permintaan dilakukan di server Dialogflow CX yang sama dan token belum habis masa berlakunya. Untuk mencapai ketersediaan tinggi, agen di-deploy di banyak server individual yang tidak berbagi cache token OAuth. Saat men-deploy solusi yang menggunakan token OAuth pihak ketiga, pertimbangkan dengan cermat untuk menerapkan proxy API guna membantu mengelola volume permintaan yang dapat dikirim agen Anda ke penyedia OAuth pihak ketiga.

Token ID agen layanan

Dialogflow CX dapat membuat token ID menggunakan agen layanan Dialogflow CX.

Token ditambahkan di header HTTP otorisasi saat Dialogflow CX memanggil webhook.

Token ID dapat digunakan untuk mengakses resource Cloud Run setelah Anda memberikan izin peran Invoker ke

[e-mail]

Jika resource Cloud Run berada dalam project resource yang sama, Anda tidak memerlukan izin IAM tambahan untuk memanggilnya.

Audiens yang digunakan untuk membuat token ID adalah seluruh URL webhook, kecuali parameter kueri. Jika Anda menggunakan Cloud Run, pastikan URL ini didukung oleh audiens Cloud Run. Misalnya, jika URL webhook adalah

https://myproject.cloudfunctions.net/my-function/method1?query=value

URL berikut harus ada di audiens kustom.

https://myproject.cloudfunctions.net/my-function/method1

Webhook apa pun juga dapat secara opsional memvalidasi token menggunakan library klien Google atau library open source seperti github.com/googleapis/google-auth-library-nodejs.

Akun Layanan

Akun layanan dapat digunakan untuk mengautentikasi permintaan webhook ke Google API mana pun yang mendukungnya.

Jika Anda belum melakukannya, buat akun layanan.

Karena akun layanan adalah akun utama, akun layanan dapat mengakses resource dalam project Anda dengan memberinya peran, seperti yang Anda lakukan untuk akun utama lainnya. Email akun layanan akan digunakan untuk membuat token akses yang akan dikirim di header Authorization permintaan webhook.

Pengguna yang mengonfigurasi webhook untuk menggunakan akun layanan harus memiliki izin berikut:

• roles/iam.serviceAccountUser

Agar Dialogflow CX dapat membuat token, Agen Layanan Dialogflow harus memiliki izin berikut:

• roles/iam.serviceAccountTokenCreator

Akun layanan juga harus memiliki izin untuk mengakses layanan yang menghosting webhook.

Catatan: Jika Anda mencoba menggunakan akun layanan di beberapa project, pastikan kebijakan organisasi Anda mendukungnya. Kedua izin harus diberikan di project yang berisi akun layanan.

Autentikasi Secret Manager

Jika Anda menggunakan header autentikasi, autentikasi dasar dengan nama pengguna dan sandi, atau OAuth pihak ketiga, Anda dapat menyimpan kredensial sebagai secret menggunakan Secret Manager. Berikut adalah langkah-langkah yang diperlukan untuk mengautentikasi webhook Anda menggunakan rahasia:

1. Buat rahasia Anda jika Anda belum memilikinya.
2. Beri peran Dialogflow Service Agent Secret Manager Secret Accessor (roles/secretmanager.secretAccessor) pada secret baru.
3. Salin kredensial Anda ke papan klip.
4. Tambahkan versi secret baru ke secret Anda. Tempelkan kredensial Anda sebagai nilai secret.
   • Jika Anda menggunakan header autentikasi, masukkan Bearer <YOUR_CREDENTIAL>.
   • Jika Anda menggunakan autentikasi nama pengguna dan sandi dasar, masukkan <YOUR_USERNAME>:<YOUR_PASSWORD> sebagai gantinya.
   • Jangan sertakan karakter baris baru di akhir.
5. Salin nama versi rahasia yang baru saja Anda tambahkan. Format namanya adalah projects/{project_id}/secrets/{secret_id}/versions/{version_id}".
6. Buka layar pengeditan webhook, lalu:
   • Jika Anda menggunakan header autentikasi, buat Header permintaan versi Secret baru. Masukkan "Authorization" sebagai Key, lalu tempel nama versi rahasia ke kotak input Secret version.
   • Jika Anda menggunakan autentikasi nama pengguna dan sandi dasar, klik Versi secret di bagian Autentikasi Dasar dan tempel nama versi secret ke kotak input Versi secret.
   • Jika Anda menggunakan OAuth pihak ketiga, klik Versi rahasia di bagian OAuth pihak ketiga dan tempel nama versi rahasia ke kotak input Versi rahasia.
7. Klik Simpan.

Catatan: Kami hanya mendukung Secret Manager global. Penggunaan secret regional tidak didukung.

Verifikasi sertifikat HTTPS

Secara default, Dialogflow CX menggunakan trust store default Google untuk memverifikasi sertifikat HTTPS. Jika Anda ingin menggunakan sertifikat yang tidak dikenali oleh trust store default Google untuk server HTTPS Anda, seperti sertifikat yang ditandatangani sendiri atau root certificate kustom, lihat Sertifikat CA kustom.

Webhook khusus lingkungan

Jika Anda menggunakan lingkungan untuk mengisolasi sistem produksi dari sistem pengembangan (direkomendasikan), Anda dapat mengonfigurasi webhook agar spesifik per lingkungan. Untuk setiap resource webhook yang Anda tentukan, Anda dapat memberikan setelan autentikasi dan URL unik untuk setiap lingkungan yang telah Anda tentukan untuk agen.

Dengan demikian, Anda dapat mengembangkan dan menguji pembaruan kode webhook dengan aman sebelum men-deploy-nya ke produksi.

Membuat atau mengedit resource webhook

Setelah layanan webhook berjalan, Anda perlu membuat resource webhook di agen yang memiliki informasi konektivitas dan autentikasi. Setelah pembuatan, Anda juga dapat mengedit setelan resource webhook kapan saja.

Untuk membuat atau mengedit resource webhook:

Konsol

1. Buka konsol Dialogflow CX.
2. Pilih project Google Cloud Anda.
3. Pilih agen Anda.
4. Pilih tab Kelola.
5. Klik Webhook.
6. Klik Buat atau klik resource webhook dalam daftar untuk mengedit.
7. Masukkan setelan resource webhook standar atau setelan resource webhook fleksibel.
8. Klik Simpan.

API

Untuk membuat resource webhook, lihat metode create untuk jenis Webhook. Untuk mengedit resource webhook (kecuali setelan khusus lingkungan), lihat metode patch atau update untuk jenis Webhook. Buka referensi Webhook API

Pilih protokol dan versi untuk referensi Webhook:

Protokol	V3	V3beta1
REST	Resource webhook	Resource webhook
RPC	Antarmuka webhook	Antarmuka webhook
C++	WebhooksClient	Tidak tersedia
C#	WebhooksClient	Tidak tersedia
Go	WebhooksClient	Tidak tersedia
Java	WebhooksClient	WebhooksClient
Node.js	WebhooksClient	WebhooksClient
PHP	Tidak tersedia	Tidak tersedia
Python	WebhooksClient	WebhooksClient
Ruby	Tidak tersedia	Tidak tersedia

Tutup

Untuk mengedit setelan khusus lingkungan untuk webhook, lihat metode patch atau update untuk jenis Environment. Buka referensi Environment API

Pilih protokol dan versi untuk referensi Lingkungan:

Protokol	V3	V3beta1
REST	Resource lingkungan	Resource lingkungan
RPC	Antarmuka lingkungan	Antarmuka lingkungan
C++	EnvironmentsClient	Tidak tersedia
C#	EnvironmentsClient	Tidak tersedia
Go	EnvironmentsClient	Tidak tersedia
Java	EnvironmentsClient	EnvironmentsClient
Node.js	EnvironmentsClient	EnvironmentsClient
PHP	Tidak tersedia	Tidak tersedia
Python	EnvironmentsClient	EnvironmentsClient
Ruby	Tidak tersedia	Tidak tersedia

Tutup

Error webhook

Jika layanan webhook Anda mengalami error saat menangani permintaan webhook, kode webhook Anda harus menampilkan salah satu kode status HTTP berikut:

• 400 Bad Request
• 401 Unauthorized
• 403 Terlarang
• 404 Tidak ditemukan
• 500 Kesalahan server
• 503 Service Unavailable

Dalam situasi error berikut, Dialogflow CX memanggil error webhook atau waktu tunggu peristiwa bawaan dan melanjutkan pemrosesan seperti biasa:

• Waktu tunggu respons terlampaui.
• Kode status error diterima.
• Respons tidak valid.
• Layanan webhook tidak tersedia.

Selain itu, jika panggilan layanan webhook dipicu oleh panggilan API deteksi maksud, kolom queryResult.webhookStatuses dalam respons deteksi maksud berisi informasi status webhook.

Percobaan ulang otomatis

Dialogflow CX mencakup mekanisme internal yang otomatis mencoba lagi jika terjadi error webhook tertentu untuk meningkatkan keandalan. Hanya error non-terminal yang dicoba lagi (misalnya, error waktu tunggu atau koneksi).

Untuk mengurangi kemungkinan panggilan duplikat:

• Tetapkan batas waktu tunggu webhook yang lebih lama.
• Mendukung idempotensi dalam logika webhook atau menghapus duplikat.

Menggunakan Cloud Run

Catatan: Bagian ini menjelaskan cara menggunakan resource Cloud Run yang aman untuk webhook Dialogflow CX. Sebaiknya jaga keamanan resource Anda. Namun, jika Anda memilih untuk mengautentikasi dengan nama pengguna dan sandi berbasis URL, atau header HTTP, Anda harus mengizinkan akses yang tidak diautentikasi ke resource Cloud Run Anda.

Dialogflow CX terintegrasi dengan Cloud Run, sehingga Anda dapat membuat webhook serverless yang aman. Jika Anda membuat resource Cloud Run yang berada di project yang sama dengan agen Anda, pilih Service Agent Auth -> ID Token di konfigurasi Auth agar agen Anda dapat memanggil webhook Anda dengan aman.

Namun, ada dua situasi di mana Anda harus menyiapkan integrasi ini secara manual:

1. Akun layanan Agen Layanan Dialogflow CX dengan alamat berikut harus ada untuk project agen Anda:

   [e-mail]

   Akun layanan khusus ini dan kunci terkait biasanya dibuat secara otomatis saat Anda membuat agen pertama untuk project. Jika agen Anda dibuat sebelum 1 November 2020, Anda dapat memicu pembuatan akun layanan khusus ini:
   1. Buat agen baru untuk project.
   2. Jalankan perintah berikut:

      gcloud beta services identity create --service=dialogflow.googleapis.com --project=agent-project-id

2. Jika fungsi webhook Anda berada di project yang berbeda dengan agen, Anda harus memberikan peran IAM Cloud Run Invoker atau Cloud Functions Invoker ke akun layanan Agen Layanan Dialogflow CX di project resource Cloud Run Anda.
3. Pilih Service Agent Auth -> ID Token di bagian konfigurasi Auth.

Menggunakan webhook dalam container dan framework Go ezcx

Jika Anda ingin menerapkan webhook dalam container menggunakan Go, lihat framework ezcx Go. Framework ini dapat menyederhanakan banyak langkah yang diperlukan saat membuat webhook.

Menggunakan Cloud Run dengan traffic khusus internal

Catatan: Penggunaan Cloud Run di luar perimeter Kontrol Layanan VPC project agen Dialogflow CX untuk webhook tidak didukung.

Resource Cloud Run yang disiapkan untuk menerima traffic internal dari jaringan VPC dalam project yang sama atau perimeter Kontrol Layanan VPC yang sama dapat digunakan sebagai webhook selama agen berada dalam project yang sama atau perimeter Kontrol Layanan VPC yang sama.

Menggunakan Direktori Layanan untuk akses jaringan pribadi

Dialogflow CX terintegrasi dengan akses jaringan pribadi Service Directory, sehingga dapat terhubung ke target webhook di dalam jaringan VPC Anda. Hal ini menjaga traffic dalam jaringan Google Cloud dan menerapkan IAM dan VPC Service Controls.

Untuk menyiapkan webhook yang menargetkan jaringan pribadi:

1. Ikuti Konfigurasi jaringan pribadi Service Directory untuk mengonfigurasi jaringan VPC dan endpoint Service Directory Anda.

   Catatan: Dialogflow CX menyimpan informasi Service Directory dalam cache selama 90 detik. Artinya, jika Anda memperbarui endpoint Service Directory, perubahan akan terjadi dalam waktu 90 detik. Selain itu, jika Anda menyiapkan beberapa endpoint untuk redundansi, Dialogflow CX dapat mengirim traffic melalui endpoint yang gagal selama 90 detik.

2. Akun layanan Agen Layanan Dialogflow CX dengan alamat berikut harus ada untuk project agen Anda:

   [e-mail]

   Berikan peran berikut ke akun layanan Dialogflow CX Service Agent di project tempat Service Directory Anda berada:

   • servicedirectory.viewer
   • servicedirectory.pscAuthorizedService

   Selain itu, jika Service Directory Anda berada dalam project yang berbeda dengan agen Dialogflow CX, Anda juga perlu memberikan peran servicedirectory.viewer ke akun Agen Layanan Dialogflow CX dalam project yang menghosting agen Dialogflow CX Anda.

3. Berikan Layanan Direktori Layanan beserta URL dan informasi autentikasi opsional saat membuat webhook.

   Konsol

   

   API

   Lihat kolom serviceDirectory untuk jenis Webhook. Buka referensi Webhook API

   Pilih protokol dan versi untuk referensi Webhook:

   Protokol	V3	V3beta1
   REST	Resource webhook	Resource webhook
   RPC	Antarmuka webhook	Antarmuka webhook
   C++	WebhooksClient	Tidak tersedia
   C#	WebhooksClient	Tidak tersedia
   Go	WebhooksClient	Tidak tersedia
   Java	WebhooksClient	WebhooksClient
   Node.js	WebhooksClient	WebhooksClient
   PHP	Tidak tersedia	Tidak tersedia
   Python	WebhooksClient	WebhooksClient
   Ruby	Tidak tersedia	Tidak tersedia

   Tutup

Untuk memecahkan masalah, Anda dapat menyiapkan pemeriksaan uptime pribadi untuk memastikan bahwa Direktori Layanan Anda dikonfigurasi dengan benar.

Contoh dan pemecahan masalah

Lihat panduan cara kerja webhook.