Ikhtisar Notifikasi#
Apidog memungkinkan Anda berintegrasi dengan aplikasi pihak ketiga untuk mengirim notifikasi kepada penerima yang ditentukan ketika peristiwa tertentu terjadi. Ketika peristiwa tertentu dipicu, notifikasi dikirim secara real-time ke platform seperti Slack. Kanal notifikasi yang saat ini didukung meliputi:Hanya admin proyek yang dapat mengonfigurasi pengaturan notifikasi. Saat ini, notifikasi email hanya tersedia untuk peristiwa berikut:Pengujian otomatis selesai/gagal
Integrasi berkelanjutan selesai/gagal
Tugas terjadwal selesai/gagal
Target Notifikasi#
Target notifikasi adalah penerima yang menerima pesan melalui kanal tertentu ketika peristiwa tertentu terjadi.Untuk menyiapkan notifikasi, pertama-tama Anda perlu membuat target notifikasi dengan menentukan nama, memilih kanal, dan mengonfigurasi pengaturannya. Setiap kanal memiliki proses penyiapan yang unik. Bagian di bawah ini akan memandu Anda mengonfigurasinya langkah demi langkah.Slack#
Apidog mendukung pengiriman peristiwa notifikasi ke Channel tertentu di Slack dengan mengintegrasikan aplikasi Slack - Incoming WebHooks di Channel yang ditentukan dan mengonfigurasi URL Webhook dari Incoming WebHooks, yang dapat mengirim pesan peristiwa ke Slack Channel.Deskripsi bidang konfigurasi:| Bidang Konfigurasi | Wajib | Deskripsi |
|---|
| Nama Notifikasi | Tidak | Berikan nama untuk notifikasi terintegrasi pihak ketiga guna mencatat tujuannya. |
| Peristiwa Pemicu | Ya | Peristiwa yang didukung: perubahan API, perubahan skema, perubahan Dokumen, impor data, pengujian otomatis |
| URL Layanan | Ya | URL Webhook dalam "Incoming WebHooks - Integration Settings" |
Mengintegrasikan Notifikasi Apidog dengan Slack#
Admin proyek dapat menggunakan fungsi integrasi pihak ketiga untuk mengaitkan aplikasi Slack - Incoming WebHooks yang ditambahkan di Slack - Channels dengan peristiwa notifikasi proyek di Apidog untuk mendorong perubahan API terkait, perubahan dokumentasi, penyelesaian pengujian, dan sebagainya ke Channel yang ditentukan di Slack.Langkah 1: Buka detail channel
Di channel Slack, klik opsi "Open channel details" di sudut kanan atas.Langkah 2: Instal Incoming WebHook
Di Integrations - Apps pada Channel tertentu, instal dan tambahkan Incoming WebHook.Langkah 3: Lihat Incoming WebHooks
Setelah instalasi selesai, klik tombol di sebelah kanan Incoming WebHooks - View.Langkah 4: Konfigurasikan Incoming WebHooks
Ini akan membuka halaman deskripsi Incoming WebHooks; klik Configuration untuk menyiapkan.Langkah 5: Tambahkan ke Slack
Langkah 6: Pilih Channel dan Tambahkan Integrasi
Pilih Channel untuk mendorong pesan peristiwa notifikasi Apidog, lalu klik Add Incoming WebHooks integration.Langkah 7: Dapatkan URL Webhook
Dapatkan dan salin URL Webhook.Langkah 8: Buat target notifikasi di Apidog
Klik "Settings" > "Notifications" > "Notification Targets" > lalu buat Target notifikasi baru.Isi nama target notifikasi.
Pilih Slack sebagai kanal notifikasi.
Tempelkan URL Webhook yang diperoleh dari pengaturan Incoming WebHooks di Service URL.
Teams#
Dukungan untuk mengirim notifikasi ke Microsoft Teams memungkinkan Workflows di Teams menggunakan pesan ini sebagai pemicu untuk tindakan lanjutan—seperti memposting pesan secara otomatis di grup atau channel—sehingga membantu tim tetap mendapatkan informasi tentang peristiwa penting dari Apidog.Secara khusus, Anda dapat mengonfigurasi Webhook Trigger dalam Workflow. Ketika peristiwa notifikasi tertentu di Apidog dipicu (misalnya, perubahan API, pembaruan dokumentasi, atau penyelesaian pengujian otomatis), Apidog akan mengirim permintaan POST ke URL HTTP POST yang ditentukan pada pemicu, dengan membawa payload peristiwa.| Bidang | Wajib | Deskripsi |
|---|
| Nama | Ya | Nama yang menjelaskan tujuan target notifikasi ini |
| URL HTTP POST | Ya | URL tempat Webhook Trigger dalam Workflow menerima permintaan POST |
Mengintegrasikan Notifikasi Apidog dengan Teams Channels#
Langkah 1: Buat workflow di Teams
Di Microsoft Teams → Workflow, klik Create, dan Anda dapat memulai dengan cepat dengan memilih templat Post to a channel when a webhook request is received.Langkah 2: Atur nama alur dan akun
Atur nama untuk alur, pilih akun yang sesuai, lalu klik Next.Langkah 3: Pilih grup dan channel
Pilih grup dan channel tempat Anda ingin menerima notifikasi, lalu klik Create flow.Langkah 4: Dapatkan URL HTTP POST
Setelah alur dibuat, URL HTTP POST di bawah langkah pemicu akan ditampilkan. Anda dapat menyalinnya langsung atau menemukannya nanti dalam langkah pemicu pada alur.Langkah 5: Konfigurasikan target notifikasi di Apidog
Tempelkan URL HTTP POST ini ke konfigurasi target notifikasi di Apidog.Langkah 6: Buat peristiwa notifikasi
Buat peristiwa notifikasi di Apidog dan kaitkan dengan target notifikasi Teams yang telah dikonfigurasi.Langkah 7: Verifikasi notifikasi Teams
Ketika peristiwa notifikasi ini dipicu, workflow yang sebelumnya dibuat akan secara otomatis memposting pesan ke channel Teams yang dipilih.Webhook#
Mendukung pengiriman peristiwa notifikasi ke HTTP Server. Anda dapat mengirim pesan peristiwa ke HTTP Server dengan menentukan alamat URL untuk menerima permintaan POST.Deskripsi bidang konfigurasi:| Bidang Konfigurasi | Wajib | Deskripsi |
|---|
| Nama Notifikasi | Tidak | Berikan nama untuk notifikasi terintegrasi pihak ketiga guna mencatat tujuan notifikasi. |
| Peristiwa Pemicu | Ya | Peristiwa yang didukung: perubahan API, perubahan model data, perubahan Dokumen, impor data, pengujian otomatis |
| URL Server | Ya | Alamat URL HTTP Server untuk menerima permintaan |
| Autentikasi Tanda Tangan | Tidak | Konten yang dikirim dienkripsi oleh algoritma enkripsi HMAC SHA1, menggunakan token sebagai KEY untuk menampilkan nilai dalam heksadesimal (memerlukan token yang dikonfigurasi), dan berisi prefiks sha1= |
Mengintegrasikan Notifikasi Apidog dengan HTTP Server yang Dihosting Sendiri#
Admin proyek dapat menggunakan integrasi pihak ketiga untuk mengaitkan HTTP Server yang dihosting sendiri dengan peristiwa notifikasi proyek di Apidog, guna menerima notifikasi untuk perubahan API yang relevan, perubahan dokumen, dan penyelesaian pengujian otomatis di HTTP Server mereka.Untuk mengintegrasikan notifikasi Apidog dengan HTTP server yang dihosting sendiri, klik "Settings" > "Notifications" > "Notification Targets" > lalu buat Target notifikasi baru.1.
Isi nama target notifikasi.
2.
Pilih Webhook sebagai kanal.
3.
Tempelkan URL HTTP Server yang dihosting sendiri di bidang Service URL.
4.
Jika verifikasi tanda tangan diaktifkan, salin dan tempelkan kunci di bidang Signature Key.
Jenkins#
Ini mendukung pengiriman peristiwa notifikasi ke layanan Jenkins. Dengan mengonfigurasi URL Webhook Jenkins, pesan peristiwa dapat dikirim ke Jenkins.Deskripsi bidang konfigurasi:| Bidang Konfigurasi | Wajib | Deskripsi |
|---|
| Nama Notifikasi | Tidak | Berikan nama untuk notifikasi integrasi pihak ketiga guna mencatat tujuannya. |
| Peristiwa Pemicu | Ya | Perubahan API, perubahan model data, impor data, pengujian otomatis. Notifikasi real-time akan dipicu ketika salah satu peristiwa di atas terjadi. |
| URL Layanan | Ya | URL dikonfigurasi di plugin Generic Webhook Trigger. |
| Autentikasi Tanda Tangan | Tidak | Dikirim ke plugin Generic Webhook Trigger melalui header Authorization Bearer. |
Mengintegrasikan Notifikasi Apidog dengan Layanan Jenkins#
Admin proyek dapat menggunakan fungsionalitas integrasi pihak ketiga untuk mengaitkan URL Webhook yang dikonfigurasi di plugin Jenkins Generic Webhook Trigger dengan peristiwa notifikasi proyek di Apidog, guna memicu tindakan build di Jenkins secara otomatis ketika peristiwa seperti perubahan API, perubahan dokumen, dan penyelesaian pengujian otomatis dipicu, serta melihat pesan dalam riwayat build.Langkah 1: URL Webhook dikonfigurasi di plugin Jenkins Generic Webhook Trigger
Buat tampilan baru di Jenkins Dashboard:Klik tampilan pada langkah sebelumnya untuk masuk ke Configure>Build Triggers, lalu pilih Generic Webhook Trigger. URL Webhook adalah "http://"+"your service address"+"/generic-webhook-trigger/invoke"Langkah 2: Buat target notifikasi baru
Klik "Settings" > "Notifications" > "Notification Targets" > lalu buat Target notifikasi baru.Isi nama target notifikasi.
Pilih Jenkins sebagai kanal
Jika token khusus digunakan, salin dan tempelkan Token ke bidang Signature Token.
Email#
Notifikasi dapat dikirim melalui email ke alamat email yang ditentukan. Saat ini, notifikasi email hanya tersedia untuk peristiwa berikut:Pengujian otomatis selesai/gagal
Integrasi berkelanjutan selesai/gagal
Tugas terjadwal selesai/gagal
| Bidang | Wajib | Detail |
|---|
| Nama | Ya | Nama deskriptif yang menyoroti tujuan atau karakteristik target notifikasi. |
| Alamat Email Notifikasi | Ya | Masukkan alamat email untuk menerima notifikasi. Anda dapat memilih alamat email anggota proyek atau mengetik alamat secara manual. Beberapa alamat email didukung. |
Mengintegrasikan Notifikasi Apidog dengan Email#
1.
Isi nama target notifikasi.
2.
Pilih Email sebagai kanal
Peristiwa Notifikasi#
Anda dapat membuat peristiwa notifikasi untuk menentukan peristiwa mana yang akan memicu notifikasi kepada penerima yang ditentukan (target notifikasi). Untuk menyiapkan peristiwa notifikasi, Anda perlu mengonfigurasi:Nama Peristiwa Notifikasi
Peristiwa Pemicu#
Anda dapat memilih dari peristiwa notifikasi berikut untuk memicu notifikasi:| Peristiwa Pemicu | Detail |
|---|
| Endpoint Berubah | Endpoint Dibuat
Endpoint Diperbarui
Endpoint Dihapus |
| Skema Berubah | Skema Dibuat
Skema Diperbarui
Skema Dihapus |
| Dokumen Berubah | Dokumen Dibuat
Dokumen Diperbarui
Dokumen Dihapus |
| Impor Data | Impor (Impor Manual)
Impor (Sinkronisasi Otomatis) |
| Komponen Respons Berubah | Komponen Respons Dibuat
Komponen Respons Diperbarui
Komponen Respons Dihapus |
| Cabang Sprint Berubah | Cabang Sprint Digabungkan
Cabang Sprint Dibuat
Cabang Sprint Diarsipkan
Cabang Sprint Dihapus
Cabang Sprint Diambil Kembali |
| Versi API Berubah | Versi API Dibuat
Versi API Dihapus |
| Skema Keamanan Berubah | Skema Keamanan Dibuat
Skema Keamanan Diperbarui
Skema Keamanan Dihapus |
Untuk notifikasi yang terkait dengan pengujian otomatis (misalnya, pengujian otomatis selesai, integrasi berkelanjutan selesai, tugas terjadwal selesai), Anda perlu mengonfigurasi pengaturan secara individual untuk setiap skenario pengujian. Pendekatan ini lebih fleksibel dan lebih sesuai dengan kasus penggunaan di dunia nyata.
Target Notifikasi#
Pilih target notifikasi mana yang akan menerima notifikasi ketika peristiwa pemicu terjadi. Anda dapat memilih dari target notifikasi yang sudah disiapkan dalam proyek dan memilih beberapa target jika diperlukan.Namun, notifikasi email hanya didukung untuk tiga peristiwa tertentu:Pengujian otomatis selesai/gagal
Integrasi berkelanjutan selesai/gagal
Tugas terjadwal selesai/gagal
