Lihat konektor yang didukung untuk Application Integration.

Pemicu webhook

Pratinjau — Webhook trigger

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Pemicu Webhook adalah pemicu Peristiwa Konektor yang memungkinkan Anda memanggil integrasi berdasarkan peristiwa apa pun yang mendukung webhook.

Penting: Integration Connectors adalah komponen Google Cloud yang dapat ditagih. Untuk informasi tentang biaya dan tagihan penggunaan Konektor Integrasi, lihat Harga Konektor Integrasi.

Sebelum memulai

Jika Anda berencana membuat atau mengonfigurasi koneksi baru untuk pemicu Webhook, pastikan Anda memiliki peran Identity and Access Management (IAM) berikut pada project:

• Admin Konektor (roles/connectors.admin)

Untuk mengetahui informasi tentang cara memberikan peran, lihat Mengelola akses.

Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk Pemicu Webhook:

• Invoker Integrasi Aplikasi (roles/integrations.integrationInvoker)

Untuk informasi tentang cara memberikan peran ke akun layanan, lihat Mengelola akses ke akun layanan.

Menambahkan pemicu Webhook

Untuk menambahkan pemicu Webhook ke integrasi Anda, lakukan langkah-langkah berikut:

1. Di konsol Google Cloud, buka halaman Application Integration.

   Buka Application Integration

2. Di menu navigasi, klik Integrasi

   Halaman Integrations List akan muncul dan mencantumkan semua integrasi yang tersedia di project Google Cloud.

3. Pilih integrasi yang ada atau klik Buat integrasi untuk membuat integrasi baru.

   Jika Anda membuat integrasi baru:

   1. Masukkan nama dan deskripsi di panel Create Integration.
   2. Pilih region untuk integrasi.
      Catatan: Dropdown Regions hanya mencantumkan region yang disediakan di project Google Cloud Anda. Untuk menyediakan wilayah baru, klik Aktifkan Wilayah. Lihat Mengaktifkan wilayah baru untuk informasi selengkapnya.
   3. Pilih akun layanan untuk integrasi. Anda dapat mengubah atau memperbarui detail akun layanan integrasi kapan saja dari panel Integration summary di toolbar integrasi.
      Catatan: Opsi untuk memilih akun layanan hanya ditampilkan jika Anda telah mengaktifkan tata kelola integrasi untuk wilayah yang dipilih.
   4. Klik Create.

   Tindakan ini akan membuka integrasi di editor integrasi.

4. Di menu navigasi editor integrasi, klik Pemicu untuk melihat daftar pemicu yang tersedia.
5. Klik dan tempatkan elemen Pemicu Webhook di editor integrasi.

Untuk mengonfigurasi pemicu Webhook, Anda dapat menggunakan koneksi Webhook yang ada yang tersedia di Integration Connectors, atau membuat koneksi Webhook baru menggunakan opsi pembuatan koneksi inline.

Mengonfigurasi pemicu Webhook menggunakan koneksi yang ada

Anda dapat mengonfigurasi pemicu Webhook menggunakan koneksi Webhook yang ada di Integration Connectors. Perhatikan bahwa pemicu Webhook adalah pemicu Peristiwa Konektor, sehingga Anda hanya dapat menggunakan koneksi Webhook dengan langganan peristiwa yang diaktifkan untuk mengonfigurasi pemicu.

Untuk mendapatkan informasi tentang cara mengonfigurasi pemicu Webhook menggunakan koneksi Webhook baru, lihat Mengonfigurasi pemicu Webhook menggunakan koneksi baru

Untuk mengonfigurasi pemicu Webhook menggunakan koneksi Webhook yang ada, lakukan langkah-langkah berikut:

1. Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
2. Klik Konfigurasi pemicu.
3. Berikan detail konfigurasi berikut di halaman Editor Pemicu Peristiwa Konektor:
   1. Region: Pilih region koneksi Webhook Anda.
   2. Koneksi: Pilih koneksi Webhook yang ingin Anda gunakan.

      Application Integration hanya menampilkan koneksi Webhook yang aktif dan memiliki langganan acara yang aktif.

   3. Jenis langganan acara: Masukkan jenis acara yang ingin Anda gunakan untuk memicu integrasi.
   4. Akun Layanan: Pilih akun layanan dengan peran IAM yang diperlukan untuk pemicu Webhook.
4. Klik Selesai untuk menyelesaikan konfigurasi pemicu dan menutup halaman.

Untuk informasi selengkapnya, lihat dokumentasi Koneksi webhook.

Mengonfigurasi pemicu Webhook menggunakan koneksi baru

Untuk mengonfigurasi Pemicu Webhook menggunakan koneksi Webhook baru, lakukan langkah-langkah berikut:

1. Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
2. Klik Konfigurasi pemicu.
3. Lewati kolom Region.
4. Klik Connection, lalu pilih opsi Create Connection dari menu.
5. Selesaikan langkah-langkah berikut di panel Create Connection:
   1. Di bagian Lokasi, pilih lokasi untuk koneksi.
      1. Region: Pilih lokasi dari daftar.

         Region yang didukung untuk konektor mencakup:

         Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

      2. Klik Next.
   2. Di bagian Connection Details, selesaikan tindakan berikut:
      1. Konektor: Pilih Webhook dari menu drop-down Konektor yang tersedia.
      2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
      3. Connection Name: Masukkan nama untuk instance Connection.

         Nama koneksi harus memenuhi kriteria berikut:

         • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
         • Huruf harus kecil.
         • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
         • Nama koneksi tidak boleh lebih dari 63 karakter.
      4. Deskripsi: Secara opsional, masukkan deskripsi untuk instance koneksi.
      5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
      6. Langganan Acara: Langganan peristiwa akan diaktifkan secara default dan bersifat wajib untuk konektor webhook.
         Catatan: Opsi Enable event subscription, entity and actions tidak didukung untuk koneksi ini.
      7. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
      8. Klik Next.
   3. Di bagian Detail Langganan Acara, lengkapi hal berikut:
      1. Autentikasi Pemroses: Pilih jenis autentikasi untuk pemroses peristiwa dan masukkan detail yang relevan.

         Jenis autentikasi berikut didukung oleh pemroses webhook:

         • Tidak Ada Autentikasi
         • Autentikasi Google: Pastikan akun layanan memiliki peran roles/connectors.listener yang token aksesnya digunakan untuk autentikasi.
         • Autentikasi Kunci API
         • Autentikasi Dasar
      2. Lokasi Kolom Jenis Peristiwa: Kolom wajib yang menunjukkan lokasi (Header, Parameter Kueri, atau Isi Permintaan) tempat jenis peristiwa yang terkait dengan permintaan peristiwa yang masuk akan ada.
      3. Nama Kolom Jenis Peristiwa: Kolom wajib di lokasi yang dikonfigurasi mengidentifikasi jenis peristiwa yang terkait dengan permintaan peristiwa masuk.

      {
      "event_type": "user.created",
      ...
      // other request fields
      ...
      }

      Pada contoh di atas, kolom event_type di isi permintaan menandakan bahwa permintaan berkaitan dengan peristiwa "user.created".
      4. Pilih Aktifkan konektivitas pribadi untuk konektivitas yang aman antara aplikasi backend dan koneksi Anda. Jika memilih opsi ini, Anda harus melakukan langkah konfigurasi tambahan setelah membuat koneksi. Untuk mengetahui informasi selengkapnya, lihat Konektivitas pribadi untuk langganan acara.
      5. Masukkan konfigurasi yang dihentikan pengirimannya. Jika Anda mengonfigurasi huruf mati, koneksi akan menulis peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
         1. ID project yang dihentikan pengirimannya: ID project Google Cloud tempat Anda mengonfigurasi topik Pub/Sub yang dihentikan pengirimannya.
         2. Topik yang dihentikan pengirimannya: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang belum diproses.
      6. Klik Next.
   4. Peninjauan: Meninjau detail koneksi dan autentikasi pemroses.
   5. Klik Create.

Output pemicu

Pemicu Webhook memerlukan waktu beberapa menit untuk menyelesaikan konfigurasi langganan peristiwa. Anda dapat melihat status langganan peristiwa di panel konfigurasi pemicu di bagian Detail Langganan Acara.

Pemicu Webhook menunjukkan status langganan peristiwa menggunakan status berikut:

• Creating: Menunjukkan bahwa pemicu berlangganan langganan peristiwa.
• Active: Menunjukkan bahwa pemicu berhasil berlangganan ke langganan peristiwa.
• Error: Menunjukkan bahwa ada masalah dengan langganan peristiwa yang dikonfigurasi.

Selain status langganan acara, bagian Detail Langganan Acara juga menampilkan detail lainnya seperti wilayah koneksi, nama koneksi, nama langganan acara, dan lainnya.

Variabel output pemicu

Untuk setiap peristiwa, Pemicu Webhook menghasilkan variabel output ConnectorEventPayload yang dapat Anda gunakan dalam tugas downstream. Variabel output dalam format JSON yang berisi skema payload Webhook output.

Lihat langganan acara

Untuk melihat dan mengelola semua langganan peristiwa yang terkait dengan koneksi di Integration Connectors, lakukan hal berikut:

1. Buka halaman Integration Connectors > Connections.

   Buka halaman Connections

2. Klik koneksi yang ingin Anda lihat langganannya.
3. Klik tab Langganan acara.

   Ini akan menampilkan semua langganan peristiwa untuk koneksi tersebut.

Edit pemicu Webhook

Anda dapat mengedit pemicu Webhook untuk mengubah atau memperbarui konfigurasi koneksi dan detail langganan peristiwa.

Penting: Saat mengedit atau mengubah pemicu Webhook, Anda dapat mempertahankan langganan peristiwa yang dikonfigurasi sebelumnya yang dilampirkan ke pemicu tersebut, atau Anda dapat menghapusnya. Menghapus langganan acara akan memengaruhi semua integrasi yang dipublikasikan menggunakan langganan acara tersebut.

Untuk mengedit pemicu Webhook, lakukan langkah-langkah berikut:

1. Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
2. Klik Konfigurasi pemicu Webhook.
3. Lakukan tindakan berikut di halaman Connector Event Trigger Editor:
   1. Untuk mempertahankan langganan peristiwa yang dikonfigurasi sebelumnya, klik Pertahankan, atau klik Hapus.
      Peringatan: Menghapus langganan acara akan memengaruhi semua integrasi yang dipublikasikan menggunakan langganan acara. Tugas ini tidak dapat diurungkan.
   2. Perbarui konfigurasi koneksi dan detail langganan peristiwa sesuai keinginan.
   3. Klik Done.

Anda dapat melihat detail langganan peristiwa dan koneksi yang diperbarui di panel konfigurasi pemicu di bagian Detail Langganan Acara.