Lihat konektor yang didukung untuk Integration Aplikasi.
Pemicu webhook
Pemicu Webhook adalah Pemicu Peristiwa Konektor yang memungkinkan Anda memanggil integrasi berdasarkan peristiwa apa pun dari backend yang mendukung webhook. Pemicu Webhook menerima peristiwa dari aplikasi berbasis SaaS pihak ketiga yang mendukung kemampuan peristiwa webhook. Pemicu ini mendukung beberapa jenis autentikasi untuk pemroses peristiwa Anda.
Sebelum memulai
Jika Anda berencana membuat atau mengonfigurasi koneksi baru untuk pemicu Webhook, pastikan Anda memiliki peran Identity and Access Management (IAM) berikut di project:
- Connector Admin (
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:
- Application Integration Invoker (
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:
- Di konsol Google Cloud, buka halaman Integrasi Aplikasi.
- Di menu navigasi, klik Integrations
Halaman Daftar Integrasi akan muncul yang mencantumkan semua integrasi yang tersedia di project Google Cloud.
- Pilih integrasi yang ada atau klik Buat integrasi untuk membuat integrasi baru.
Jika Anda membuat integrasi baru:
- Masukkan nama dan deskripsi di panel Buat Integrasi.
- Pilih region untuk integrasi.
- Pilih akun layanan untuk integrasi. Anda dapat mengubah atau memperbarui detail akun layanan integrasi kapan saja dari panel Ringkasan integrasi di toolbar integrasi.
- Klik Create.
Tindakan ini akan membuka integrasi di editor integrasi.
- Di menu navigasi editor integrasi, klik Pemicu untuk melihat daftar pemicu yang tersedia.
- Klik dan tempatkan elemen Pemicu webhook di editor integrasi.
Untuk mengonfigurasi Pemicu webhook, Anda dapat menggunakan koneksi Webhook yang ada di Konektor Integrasi, 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 Konektor Integrasi. Perhatikan bahwa pemicu Webhook adalah pemicu Peristiwa Konektor, sehingga Anda hanya dapat menggunakan koneksi Webhook dengan langganan peristiwa yang diaktifkan untuk mengonfigurasi pemicu.
Untuk mengetahui 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:
- Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
- Klik Konfigurasi pemicu.
- Berikan detail konfigurasi berikut di halaman Editor Pemicu Peristiwa Konektor:
- Region: Pilih region koneksi Webhook Anda.
- Koneksi: Pilih koneksi Webhook yang ingin Anda gunakan.
Integrasi Aplikasi hanya menampilkan koneksi Webhook yang aktif dan telah mengaktifkan langganan peristiwa.
- Jenis langganan peristiwa: Masukkan jenis peristiwa yang ingin Anda gunakan untuk memicu integrasi.
- Service Account: Pilih akun layanan dengan peran IAM yang diperlukan untuk pemicu Webhook.
- Klik Selesai untuk menyelesaikan konfigurasi pemicu dan menutup halaman.
Mengonfigurasi pemicu Webhook menggunakan koneksi baru
Untuk mengonfigurasi pemicu Webhook menggunakan koneksi Webhook baru, lakukan langkah-langkah berikut:
- Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
- Klik Konfigurasi pemicu.
- Lewati kolom Region.
- Klik Koneksi, lalu pilih opsi Buat Koneksi dari menu.
- Selesaikan langkah-langkah berikut di panel Buat Koneksi:
- Di bagian Location, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari daftar.
Region yang didukung untuk konektor meliputi:
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Klik Berikutnya.
- Region: Pilih lokasi dari daftar.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Konektor: Pilih Webhook dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
- Nama Koneksi: Masukkan nama untuk instance Koneksi.
Nama koneksi harus memenuhi kriteria berikut:
- Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
- Huruf harus berupa huruf kecil.
- Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh melebihi 49 karakter.
- Untuk konektor yang mendukung langganan peristiwa, nama koneksi tidak boleh diawali dengan awalan "goog".
- Deskripsi: Masukkan deskripsi untuk instance koneksi (opsional).
- Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
- Langganan Peristiwa: Langganan peristiwa akan diaktifkan secara default dan wajib untuk konektor webhook.
- Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
- Klik Berikutnya.
-
Di bagian Event Subscription Details, selesaikan tindakan berikut:
- Autentikasi Pemroses: Pilih jenis autentikasi untuk pemroses peristiwa dan masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh pemroses webhook:
- Tanpa Autentikasi
- Autentikasi Google: Pastikan akun layanan memiliki peran roles/connectors.listener yang token aksesnya digunakan untuk autentikasi.
- Autentikasi Kunci API
- Autentikasi Dasar
- Event Type Field Location: Kolom wajib yang menunjukkan lokasi (Header, Query Param, atau Request Body) tempat jenis peristiwa yang terkait dengan permintaan peristiwa yang masuk akan ada.
- Nama Kolom Jenis Peristiwa: Kolom wajib di lokasi yang dikonfigurasi mengidentifikasi jenis peristiwa yang terkait dengan permintaan peristiwa yang masuk.
- Pilih Aktifkan konektivitas pribadi untuk konektivitas 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 peristiwa.
- Masukkan konfigurasi dead-letter. Jika Anda mengonfigurasi dead-letter, koneksi akan menulis peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
- Project ID dead-letter: Project ID Google Cloud tempat Anda mengonfigurasi topik dead-letter Pub/Sub.
- Topik dead-letter: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang tidak diproses.
- Klik Berikutnya.
Pada contoh di atas, kolom event_type di request body menunjukkan bahwa permintaan berkaitan dengan peristiwa "user.created".{ "event_type": "user.created", ... // other request fields ... }
- Autentikasi Pemroses: Pilih jenis autentikasi untuk pemroses peristiwa dan masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi pemroses Anda.
- Klik Create.
- Di bagian Location, pilih lokasi untuk koneksi.
Output pemicu
Pemicu Webhook memerlukan waktu beberapa menit untuk menyelesaikan konfigurasi langganan peristiwa. Anda dapat melihat status langganan peristiwa di panel konfigurasi pemicu pada bagian Detail Langganan Peristiwa.
Pemicu webhook menunjukkan status langganan peristiwa menggunakan status berikut:
Creating
: Menunjukkan bahwa pemicu berlangganan langganan peristiwa.Active
: Menunjukkan bahwa pemicu berhasil berlangganan langganan peristiwa.Error
: Menunjukkan bahwa ada masalah dengan langganan peristiwa yang dikonfigurasi.
Selain status langganan peristiwa, bagian Detail Langganan Peristiwa juga menampilkan detail lainnya seperti wilayah koneksi, nama koneksi, nama langganan peristiwa, dan lainnya.
Memicu variabel output
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.
Melihat langganan peristiwa
Untuk melihat dan mengelola semua langganan peristiwa yang terkait dengan koneksi di Konektor Integrasi, lakukan hal berikut:
- Buka halaman Integration Connectors > Connections.
- Klik koneksi yang langganannya ingin Anda lihat.
- Klik tab Langganan peristiwa.
Tindakan ini akan menampilkan semua langganan peristiwa untuk koneksi.
Mengedit pemicu Webhook
Anda dapat mengedit Pemicu webhook untuk mengubah atau memperbarui konfigurasi koneksi dan detail langganan peristiwa.
Untuk mengedit pemicu Webhook, lakukan langkah-langkah berikut:
- Klik elemen Webhook trigger di editor integrasi untuk membuka panel konfigurasi pemicu.
- Klik Configure Webhook trigger.
- Lakukan tindakan berikut di halaman Editor Pemicu Peristiwa Konektor:
- Untuk mempertahankan langganan peristiwa yang dikonfigurasi sebelumnya, klik Pertahankan, atau klik Hapus.
- Perbarui konfigurasi koneksi dan detail langganan peristiwa sesuai keinginan.
- Klik Done.
Anda dapat melihat detail koneksi dan langganan peristiwa yang diperbarui di panel konfigurasi pemicu di bagian Detail Langganan Peristiwa.
Kuota dan batas
Untuk mengetahui informasi tentang kuota dan batas, lihat Kuota dan batas.
Langkah selanjutnya
- Pelajari semua tugas dan pemicu.
- Pelajari cara menguji dan memublikasikan integrasi.
- Pelajari penanganan error.
- Pelajari log eksekusi integrasi.