☰ Menu · Events
API reference

Events

Every event type, what triggers it and what is in data.object.

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",
      ...
    }
  }
}
TypeSent whendata.object
member.createdA guest was enrolled through the API, for example by a till or a kiosk.member
member.updatedProfile or card number changed.member
member.scannedA device called POST /v1/scans and the member was found.scan
transaction.completedA check was applied through the API, by any integration of the venue.transaction
transaction.voidedA check was voided.transaction
transaction.refundedPart of a check was refunded.refund
balance.adjustedCashback was added or taken away by hand.adjustment
visit.createdA visit was recorded with POST /v1/visits.visit
reward.unlockedA stamp card was completed.reward
reward.redeemedA stamp reward was given.reward
gift.unlockedA check opened a gift (spend threshold or level). Only for venues with gifts.gift
gift.givenA gift was marked handed out.gift
order.createdA guest sent an order from the QR menu.order
order.updatedAn order changed status. Includes previous_status.order
menu.updatedDishes changed through the API.menu_change
test.pingYou pressed Test or called the test endpoint.ping

Events are sent for changes made through the API. Changes made in the venue's own cashier app are not sent yet; read them with GET /v1/members/{member}/history. More types will be added. Ignore types you do not know. Delivery, signatures and retries are described in the Webhooks guide.