☰ Menü · Olaylar
API referansı
Olaylar
Tüm olay türleri, neyin tetiklediği ve data.object içinde ne olduğu.
JSON
{
"id": "evt_5a1f0c9e2b7d4e3f81a0c6d2",
"object": "event",
"type": "order.created",
"created": 1791310488,
"livemode": true,
"data": {
"object": {
"object": "order",
"id": "0c69a81c-0fbc-4333-b26c-789566b9bea4",
"number": 10,
"status": "new",
"table": "7",
...
}
}
}| Tür | Ne zaman gönderilir | data.object |
|---|---|---|
| member.created | Bir misafir API üzerinden kaydedildi, örneğin kasa veya kiosk tarafından. | member |
| member.updated | Profil veya kart numarası değişti. | member |
| member.scanned | Bir cihaz POST /v1/scans çağırdı ve üye bulundu. | scan |
| transaction.completed | İşletmenin herhangi bir entegrasyonu API üzerinden fiş işledi. | transaction |
| transaction.voided | Bir fiş iptal edildi. | transaction |
| transaction.refunded | Bir fişin bir kısmı iade edildi. | refund |
| balance.adjusted | Cashback elle eklendi veya düşüldü. | adjustment |
| visit.created | POST /v1/visits ile ziyaret kaydedildi. | visit |
| reward.unlocked | Bir damga kartı tamamlandı. | reward |
| reward.redeemed | Bir damga ödülü verildi. | reward |
| order.created | Misafir QR menüden sipariş gönderdi. | order |
| order.updated | Siparişin durumu değişti. previous_status içerir. | order |
| menu.updated | Ürünler API üzerinden değiştirildi. | menu_change |
| test.ping | Test butonuna bastınız veya test uç noktasını çağırdınız. | ping |
Olaylar, API üzerinden yapılan değişiklikler için gönderilir. İşletmenin kendi kasiyer uygulamasında yapılan değişiklikler henüz gönderilmiyor, bunları GET /v1/members/{member}/history ile okuyun. Yeni türler eklenecek, bilmediğiniz türleri yok sayın. Gönderim, imzalar ve yeniden denemeler Webhook rehberinde anlatılıyor.