Pengelolaan webhook tersedia di /api/v2/webhooks. Perlakukan URL webhook dan material signing sebagai secret.
Sebelum memulai
Buat API key dengan akses workspace minimum dan tentukan event family yang diperlukan integrasi.
Langkah
- Buka Settings → Integrations.
- Buat atau pilih tujuan webhook.
- Catat event ID yang dikonfigurasi dan status endpoint.
- Kirim test request ke receiver non-production.
- Verifikasi response dan periksa delivery attempt sebelum mengaktifkan pemrosesan production.
Buat receiver idempotent. Simpan event identifier dan acknowledge hanya setelah payload divalidasi. Jangan menganggap semua event internal aplikasi sebagai customer webhook yang didukung.
Mengonfigurasi dan memverifikasi webhook
- Buat endpoint yang menerima payload, menyimpan event identifier sebelum mengembalikan response sukses.
- Di Settings → Integrations, buat webhook dengan Name, Target hook URL, Event type, dan bila ada Campaign atau custom interest value.
- Simpan, buka tujuan, lalu gunakan Test. Pastikan receiver mencatat event dan API melaporkan
success: true. - Tinjau Webhook events untuk
status_code,success,retry_count,will_retry, danerror_message. - Hapus atau perbarui tujuan saat URL berubah; menghapus tujuan tidak menghapus delivery attempt historis.
Gunakan cursor pagination (limit dan starting_after) untuk history. Perlakukan retry sebagai at-least-once delivery dan buat consumer idempotent.
Pemulihan kegagalan
Response receiver 4xx biasanya memerlukan perbaikan payload atau autentikasi; 5xx atau timeout dapat diulang dengan backoff terbatas. Konfirmasi attempt berikutnya di Webhook events dan eskalasi dengan event ID serta status yang disamarkan.
Referensi field webhook
| Field | Wajib | Arti |
|---|---|---|
| Name | Ya | Label workspace untuk tujuan. |
| Target hook URL | Ya | Endpoint HTTPS yang menerima delivery. |
| Event type | Ya | Event identifier dari endpoint event-types. |
| Campaign | Opsional | Membatasi event ke satu campaign saat dipilih. |
| Custom interest value | Bersyarat | Wajib saat event yang dipilih adalah label custom interest. |
Verifikasi delivery
Setelah Test, pastikan receiver menyimpan event ID, mengembalikan response sukses, dan tidak membuat record duplikat saat retry. Di Webhook events, periksa status_code, success, retry_count, will_retry, error_message, dan timestamp_next_retry.