- Beranda
- Referensi API
- Webhook
- Lihat pengiriman webhook
Lihat pengiriman webhook
Mengembalikan payload event dan setiap percobaan pengiriman, termasuk waktu, status HTTP, dan respons server.
/v1/webhook-deliveries/{id}webhooks:read.Parameter path
Section titled “Parameter path”idstringwajibId pengiriman (wdl_…).
Contoh: wdl_01k7q3m8x2v5t9n4b6c1d0e7fa
Diawali wdl_.
Respons (200)
Section titled “Respons (200)”dataobjectwajibObjek yang dikembalikan, atau array objek untuk operasi daftar.
deliveryobjectwajibStatus pengiriman event ini ke satu endpoint.
idstringwajibId pengiriman (wdl_…).
Contoh: wdl_01k7q3m8x2v5t9n4b6c1d0e7fa
Diawali wdl_.
event_idstringwajibEvent yang dikirim (wev_…).
Contoh: wev_01k7q3m8x2v5t9n4b6c1d0e7fa
Diawali wev_.
event_typestringwajibNama event di dalam payload, misalnya payment.succeeded; gunakan untuk menentukan handler event yang dijalankan.
Contoh: payment.succeeded
Nilai yang mungkin: payment.created, payment.succeeded, payment.failed, payment.expired, payment.settled, payment.anomaly, payment.unsettled, payment.reversed, payment.reversal_cancelled, payment.attempt.created, payment.attempt.failed, payment_link.created, payment_link.cancelled, payment_link.expired, payment_link.completed, payment_link.limit_reached, invoice.issued, invoice.paid, invoice.voided, project.created, project.updated, project.activated, project.deactivated, project.payment_methods_changed, project.live_requested, project.live_approved, project.live_revision_requested, api_key.created, api_key.rotated, api_key.revoked, webhook_endpoint.created, webhook_endpoint.updated, webhook_endpoint.deleted, webhook_endpoint.secret_rotated, webhook_endpoint.disabled, webhook.test
payment_idstring | nullwajibPembayaran terkait; null jika event tidak membahas pembayaran.
Contoh: pay_01k7q3m8x2v5t9n4b6c1d0e7fa
Diawali pay_.
simulatedbooleanwajibtrue untuk event uji atau skenario sandbox.
endpoint_idstringwajibEndpoint tujuan pengiriman (whk_…).
Contoh: whk_01k7q3m8x2v5t9n4b6c1d0e7fa
Diawali whk_.
statusstringwajibpending berarti masuk antrean, retrying akan dikirim lagi, succeeded berarti endpoint membalas dengan status 2xx, dan failed berarti tidak ada percobaan ulang lagi.
Contoh: succeeded
Nilai yang mungkin: pending, retrying, succeeded, failed
attempt_countintegerwajibJumlah percobaan pengiriman sampai sekarang, termasuk percobaan terakhir.
Contoh: 1
next_attempt_atstring | nullwajibWaktu percobaan ulang pengiriman berikutnya; null jika tidak ada percobaan ulang yang dijadwalkan.
Contoh: 2026-10-26T03:04:05.000Z
Format: date-time
last_status_codeinteger | nullwajibStatus HTTP yang dijawab servermu pada percobaan terakhir; null bila tidak menjawab.
Contoh: 200
last_error_codestring | nullwajibKode pendek kenapa percobaan terakhir gagal; null bila tidak gagal.
Contoh: string
delivered_atstring | nullwajibWaktu endpoint pertama kali menerima event; null sampai pengiriman berhasil.
Contoh: 2026-10-26T03:04:05.000Z
Format: date-time
created_atstringwajibWaktu objek ini dibuat (RFC 3339, UTC). Gunakan untuk mengurutkan objek berdasarkan waktu pembuatan.
Contoh: 2026-10-26T03:04:05.000Z
Format: date-time
payloadobjectwajibYang dikirim: event, sebagai satu objek JSON.
Nilai: object
attemptsarray dari objectwajibSetiap percobaan pengiriman HTTP ke endpoint ini, diurutkan dari yang terlama.
attempt_nointegerwajib1 untuk percobaan pertama.
Contoh: 1
attempted_atstringwajibKapan percobaan dilakukan (RFC 3339, UTC).
Contoh: 2026-10-26T03:04:05.000Z
Format: date-time
status_codeinteger | nullwajibStatus HTTP yang dijawab servermu; null bila tidak menjawab.
Contoh: 200
duration_msintegerwajibBerapa lama panggilan berlangsung, dalam milidetik.
Contoh: 143
response_snippetstring | nullwajibAwal jawaban servermu; null bila tidak ada jawaban.
Contoh: string
error_codestring | nullwajibKode pendek kenapa percobaan gagal; null bila berhasil.
Contoh: string
metaobjectwajibDetail request seperti id dan kursor paginasi.
request_idstringwajibId request ini. Sebutkan saat bertanya ke dukungan.
Contoh: req_Hy3k9QzT2LmN8vXa
Request yang gagal dijawab dengan bentuk error yang sama; lihat Error.
curl "https://api.baiyar.com/v1/webhook-deliveries/{id}" \ -H "Authorization: Bearer $BAIYAR_KEY"{ "data": { "delivery": { "id": "wdl_01k7q3m8x2v5t9n4b6c1d0e7fa", "event_id": "wev_01k7q3m8x2v5t9n4b6c1d0e7fa", "event_type": "payment.succeeded", "payment_id": "pay_01k7q3m8x2v5t9n4b6c1d0e7fa", "simulated": false, "endpoint_id": "whk_01k7q3m8x2v5t9n4b6c1d0e7fa", "status": "succeeded", "attempt_count": 1, "next_attempt_at": "2026-10-26T03:04:05.000Z", "last_status_code": 200, "last_error_code": "string", "delivered_at": "2026-10-26T03:04:05.000Z", "created_at": "2026-10-26T03:04:05.000Z" }, "payload": {}, "attempts": [ { "attempt_no": 1, "attempted_at": "2026-10-26T03:04:05.000Z", "status_code": 200, "duration_ms": 143, "response_snippet": "string", "error_code": "string" } ] }, "meta": { "request_id": "req_Hy3k9QzT2LmN8vXa" }}