Halaman ini menjelaskan cara menyiapkan webhook untuk mengirim pesan asinkron ke ruang Chat menggunakan pemicu eksternal. Misalnya, Anda dapat mengonfigurasi aplikasi pemantauan untuk memberi tahu staf siaga di Chat saat server mati. Untuk mengirim pesan sinkron dengan aplikasi Chat, lihat Mengirim pesan.
Dengan jenis desain arsitektur ini, pengguna tidak dapat berinteraksi dengan webhook atau aplikasi eksternal yang terhubung karena komunikasi bersifat satu arah. Webhook bukanlah percakapan. Mereka tidak dapat merespons atau menerima pesan dari pengguna atau peristiwa interaksi aplikasi Chat. Untuk merespons pesan, build aplikasi Chat, bukan webhook.
Meskipun webhook secara teknis bukanlah aplikasi Chat, webhook menghubungkan aplikasi menggunakan permintaan HTTP standar. Halaman ini merujuknya sebagai aplikasi Chat untuk penyederhanaan. Setiap webhook hanya berfungsi di ruang Chat tempat webhook didaftarkan. Webhook masuk berfungsi di pesan langsung, tetapi hanya jika semua pengguna telah mengaktifkan aplikasi Chat. Anda tidak dapat memublikasikan webhook ke Google Workspace Marketplace.
Diagram berikut menunjukkan arsitektur webhook yang terhubung ke Chat:
Dalam diagram sebelumnya, aplikasi Chat memiliki alur informasi berikut:
- Logika aplikasi Chat menerima informasi dari layanan pihak ketiga eksternal, seperti sistem pengelolaan project atau alat penjualan tiket.
- Logika aplikasi Chat dihosting di sistem cloud atau lokal yang dapat mengirim pesan menggunakan URL webhook ke ruang Chat tertentu.
- Pengguna dapat menerima pesan dari aplikasi Chat di ruang Chat tertentu, tetapi tidak dapat berinteraksi dengan aplikasi Chat.
Prasyarat
Python
- Akun Google Workspace dengan akses ke Chat. Organisasi Google Workspace Anda harus mengizinkan pengguna menambahkan dan menggunakan webhook masuk.
- Python 3.10.7 atau yang lebih baru.
Library
httplib2
. Jika perlu, jalankan perintah antarmuka command line (CLI) berikut untuk menginstal library menggunakanpip
:pip install httplib2
Ruang Chat yang sudah ada.
Node.js
- Akun Google Workspace dengan akses ke Chat. Organisasi Google Workspace Anda harus mengizinkan pengguna menambahkan dan menggunakan webhook masuk.
- Node.js & npm sudah diinstal.
- Ruang Chat yang sudah ada.
Java
- Akun Google Workspace dengan akses ke Chat. Organisasi Google Workspace Anda memungkinkan pengguna menambahkan dan menggunakan webhook masuk.
- Java 11 atau yang lebih baru.
- Maven Apache
- Ruang Chat yang sudah ada.
Apps Script
- Akun Google Workspace dengan akses ke Chat. Organisasi Google Workspace Anda memungkinkan pengguna menambahkan dan menggunakan webhook masuk.
- Ruang Chat yang sudah ada.
Membuat webhook
Untuk membuat webhook, daftarkan webhook di ruang Chat tempat Anda ingin menerima pesan, lalu tulis skrip yang mengirim pesan.
Mendaftarkan webhook masuk
- Di browser, buka Chat. Webhook tidak dapat dikonfigurasi dari aplikasi seluler Chat.
- Buka ruang tempat Anda ingin menambahkan webhook.
- Di samping judul ruang, klik panah luaskan, lalu klik Apps & integration.
Klik
Tambahkan webhook.Di kolom Name, masukkan
Quickstart Webhook
.Di kolom Avatar URL, masukkan
https://developers.google.com/chat/images/chat-product-icon.png
.Klik Save.
Untuk menyalin URL webhook, klik
Lainnya, lalu klik Salin link.
Menulis skrip webhook
Contoh skrip webhook mengirim pesan ke ruang tempat webhook didaftarkan dengan mengirim permintaan POST
ke URL webhook. Chat
API merespons dengan instance
Message
.
Pilih bahasa untuk mempelajari cara membuat skrip webhook:
Python
Di direktori kerja Anda, buat file bernama
quickstart.py
.Di
quickstart.py
, tempel kode berikut:Ganti nilai untuk variabel
url
dengan URL webhook yang Anda salin saat mendaftarkan webhook.
Node.js
Di direktori kerja Anda, buat file bernama
index.js
.Di
index.js
, tempel kode berikut:Ganti nilai untuk variabel
url
dengan URL webhook yang Anda salin saat mendaftarkan webhook.
Java
Di direktori kerja Anda, buat file bernama
pom.xml
.Di
pom.xml
, salin dan tempel perintah berikut:Dalam direktori kerja, buat struktur direktori berikut
src/main/java
.Di direktori
src/main/java
, buat file bernamaApp.java
.Di
App.java
, tempel kode berikut:Ganti nilai untuk variabel
URL
dengan URL webhook yang Anda salin saat mendaftarkan webhook.
Apps Script
Di browser, buka Apps Script.
Klik Project Baru
Tempelkan kode berikut:
Ganti nilai untuk variabel
url
dengan URL webhook yang Anda salin saat mendaftarkan webhook.
Menjalankan skrip webhook
Di CLI, jalankan skrip:
Python
python3 quickstart.py
Node.js
node index.js
Java
mvn compile exec:java -Dexec.mainClass=App
Apps Script
- Klik Run.
Saat Anda menjalankan kode, webhook akan mengirim pesan ke ruang tempat Anda mendaftarkannya.
Memulai atau membalas rangkaian pesan
Tentukan
spaces.messages.thread.threadKey
sebagai bagian dari isi permintaan pesan. Bergantung pada apakah Anda memulai atau membalas thread, gunakan nilai berikut untukthreadKey
:Jika memulai thread, setel
threadKey
ke string arbitrer, tetapi catat nilai ini untuk memposting balasan ke thread.Jika membalas thread, tentukan
threadKey
yang telah ditetapkan saat thread dimulai. Misalnya, untuk memposting balasan ke rangkaian pesan tempat pesan awal menggunakanMY-THREAD
, tetapkanMY-THREAD
.
Tentukan perilaku thread jika
threadKey
yang ditentukan tidak ditemukan:Membalas rangkaian pesan atau memulai rangkaian pesan baru. Tambahkan parameter
messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
ke URL webhook. Meneruskan parameter URL ini akan menyebabkan Chat mencari thread yang ada menggunakanthreadKey
yang ditentukan. Jika ditemukan, pesan akan diposting sebagai balasan ke rangkaian pesan tersebut. Jika tidak ada yang ditemukan, pesan akan memulai thread baru yang sesuai denganthreadKey
tersebut.Membalas rangkaian pesan atau tidak melakukan apa pun. Tambahkan parameter
messageReplyOption=REPLY_MESSAGE_OR_FAIL
ke URL webhook. Meneruskan parameter URL ini akan menyebabkan Chat mencari thread yang ada menggunakanthreadKey
yang ditentukan. Jika ditemukan, pesan akan diposting sebagai balasan ke rangkaian pesan tersebut. Jika tidak ada yang ditemukan, pesan tidak akan dikirim.
Untuk mempelajari lebih lanjut, lihat
messageReplyOption
.
Contoh kode berikut memulai atau membalas rangkaian pesan: