☰ 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ürNe zaman gönderilirdata.object
member.createdBir misafir API üzerinden kaydedildi, örneğin kasa veya kiosk tarafından.member
member.updatedProfil veya kart numarası değişti.member
member.scannedBir cihaz POST /v1/scans çağırdı ve üye bulundu.scan
transaction.completedİşletmenin herhangi bir entegrasyonu API üzerinden fiş işledi.transaction
transaction.voidedBir fiş iptal edildi.transaction
transaction.refundedBir fişin bir kısmı iade edildi.refund
balance.adjustedCashback elle eklendi veya düşüldü.adjustment
visit.createdPOST /v1/visits ile ziyaret kaydedildi.visit
reward.unlockedBir damga kartı tamamlandı.reward
reward.redeemedBir damga ödülü verildi.reward
gift.unlockedBir fiş hediye açtı (alışveriş eşiği veya seviye). Yalnızca hediyesi olan işletmelerde.gift
gift.givenBir hediye verildi olarak işaretlendi.gift
order.createdMisafir QR menüden sipariş gönderdi.order
order.updatedSiparişin durumu değişti. previous_status içerir.order
menu.updatedÜrünler API üzerinden değiştirildi.menu_change
test.pingTest 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.