Webhook
Konektor Webhook memungkinkan Anda memproses peristiwa dari backend yang mendukung webhook. Konektor ini dirancang untuk digunakan dengan pemicu 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. Untuk menggunakan pemicu Webhook dalam integrasi, Anda harus mengonfigurasi konektor Webhook terlebih dahulu.
Sebelum memulai
Sebelum menggunakan konektor Webhook, lakukan tugas berikut:
- Di project Google Cloud Anda:
- Aktifkan layanan berikut:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.
- Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.
Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.
- Aktifkan layanan berikut:
Mengonfigurasi konektor
Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:
- Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.
- Klik + Buat baru untuk membuka halaman Buat Koneksi.
- Di bagian Location, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
- Klik Berikutnya.
- Region: Pilih lokasi dari menu drop-down.
- 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.
Menggunakan koneksi Webhook dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.
Mendapatkan bantuan dari komunitas Google Cloud
Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.Langkah selanjutnya
- Pahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.