Peristiwa · Peristiwa layanan webhook
webhook.ping
Peristiwa uji
Peristiwa uji yang dikirim oleh POST /v1/webhooks/{webhook_id}/test. Peristiwa ini tidak dapat dijadikan langganan dan tidak dicatat di umpan peristiwa.
- Jenis objek
- webhook
- Dikirim ke
- Webhook dengan peran admin
Payload
idstringwajibID peristiwa (
evt_…), juga dikirim sebagai headerwebhook-id. Gunakan untuk membuang pengiriman duplikat.typestringwajibNilai yang diizinkan:
webhook.pingcreated_atstring (date-time)wajibKapan perubahan terjadi (UTC).
org_idintegerwajibapi_versionstringwajibVersi kontrak skema
data.sequenceintegerNomor urut pengiriman dalam webhook (tidak ada untuk peristiwa uji).
payloadstringwajibthinberarti tanpadata: baca objek melalui API.Nilai yang diizinkan:
fullthindataobjectField
endpoint_idintegerwajibmessagestringwajibrequested_byinteger | null
testbooleanwajibPeristiwa uji yang dikirim oleh
POST /v1/webhooks/{webhook_id}/test.
Contoh pengiriman
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "webhook.ping",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"object": {
"type": "webhook",
"id": "4"
},
"payload": "full",
"data": {
"endpoint_id": 4,
"message": "Test event from the knowledge platform",
"requested_by": 7
},
"test": true
}Menerima peristiwa
Setiap pengiriman adalah permintaan POST dengan isi JSON ini ke URL penerima webhook Anda. Periksa header webhook-signature (Standard Webhooks) sebelum Anda memercayai isinya, jawab dengan status 2xx dalam beberapa detik, lalu kerjakan prosesnya sesudahnya. Pengiriman ke satu webhook mempertahankan urutan peristiwa; pengiriman yang gagal dicoba ulang dengan jeda yang makin panjang.
Jenis peristiwa baru dan field baru dapat muncul kapan saja: lewati jenis dan field yang tidak Anda kenal.
Peristiwa yang sama tersedia di umpan peristiwa selama 30 hari →