Ikhtisar
Alih-alih melakukan pollingGET /jobs/{id} berulang kali, Anda dapat menyediakan URL webhook untuk menerima POST request saat job Anda selesai. Ini lebih efisien dan mengurangi panggilan API yang tidak perlu.
Menggunakan Webhooks
Tambahkan headerX-Webhook-URL ke request generasi mana pun. Ketika job mencapai status terminal (completed, failed, atau cancelled), API akan mengirim POST request ke URL Anda dengan data job lengkap.
Payload Webhook
Ketika job selesai, URL webhook Anda menerima POST request dengan data job:Praktik Terbaik
Merespons dengan cepat - Kembalikan status code 2xx sesegera mungkin. Proses data webhook secara asinkron bila perlu.
- Gunakan endpoint HTTPS untuk keamanan
- Terapkan idempotensi untuk menangani pengiriman ganda
- Log penerimaan webhook untuk debugging
Webhooks vs Polling
Gunakan webhooks bila Anda memiliki server yang dapat menerima HTTP request. Gunakan polling untuk aplikasi sisi klien atau ketika Anda tidak dapat mengekspos endpoint publik.
Langkah Berikutnya
Job Lifecycle
Pelajari status job dan polling status
Contoh Kode
Lihat contoh lengkap dengan penanganan webhook