Webhook adalah permintaan HTTP yang dihantar oleh perkhidmatan ke URL yang anda daftarkan setiap kali peristiwa tertentu berlaku. Ia membolehkan sistem anda menerima data seiring berlakunya peristiwa, bukannya memanggil API berulang kali untuk melihat jika ada yang baru tersedia. Dalam saluran data, ini bermakna satu tugas boleh bertindak balas kepada peristiwa sebaik sahaja sumber melaporkannya.
Platform pembayaran Stripe, sebagai contoh, menghantar peristiwa webhook ke titik akhir anda melalui HTTPS sebagai muatan JSON. Titik akhir anda mesti menerima permintaan POST dan memproses data peristiwa yang diterima.
Cara Penghantaran Webhook Berfungsi
Dokumentasi Stripe menunjukkan mekanik utama:
- Pendaftaran: Anda mendaftar URL titik akhir. Dalam mod langsung, Stripe memerlukan URL HTTPS yang boleh diakses secara awam.
- Pengakuan cepat: Titik akhir harus mengembalikan kod status 2xx dengan cepat, sebelum sebarang logik kompleks yang boleh menyebabkan masa tamat.
- Cuba semula: Jika penghantaran gagal, Stripe akan mencuba semula selama sehingga tiga hari dengan pengurangan eksponen dalam mod langsung.
- Pengurutan: Stripe tidak menjamin bahawa peristiwa tiba dalam urutan ia dicipta.
Mengamankan Titik Akhir Webhook
- Sahkan tandatangan: Stripe menandatangani setiap peristiwa dengan HMAC menggunakan SHA-256 dan meletakkan tandatangan dalam header
Stripe-Signature. - Halang ulang: Muatan yang ditandatangani termasuk cap waktu, jadi anda boleh menolak peristiwa yang terlalu lama.
- Tangani duplikasi: Titik akhir boleh menerima peristiwa yang sama lebih dari sekali. Log ID peristiwa yang diproses dan lewati ulangan.
- Senarai pengirim yang dibenarkan: Stripe menghantar webhook dari senarai alamat IP yang diterbitkan yang boleh anda hadkan pada firewall anda.
Penggunaan Webhook yang Biasa
- Kod dan penyebaran: GitHub menghantar muatan HTTP POST ke URL anda untuk peristiwa repositori yang anda langgani. Dokumen mereka menyenaraikan penggunaan seperti memulakan binaan CI, mengemas kini pengesan isu luaran, menyegarkan cermin sandaran dan menyebarkan ke pelayan pengeluaran.
- Pembayaran: Webhook Stripe membolehkan anda bertindak balas kepada peristiwa asinkron, seperti bank yang mengesahkan pembayaran, pelanggan yang membantah caj atau pembayaran berulang yang berjaya.
- Langgan hanya apa yang anda perlukan: Stripe menasihatkan agar tidak mendengar untuk peristiwa tambahan atau semua peristiwa kerana ia memberi tekanan yang tidak wajar pada pelayan anda.