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",
      ...
    }
  }
}

Type	Sent when	data.object
member.created	A guest was enrolled through the API, for example by a till or a kiosk.	member
member.updated	Profile or card number changed.	member
member.scanned	A device called `POST /v1/scans` and the member was found.	scan
transaction.completed	A check was applied through the API, by any integration of the venue.	transaction
transaction.voided	A check was voided.	transaction
transaction.refunded	Part of a check was refunded.	refund
balance.adjusted	Cashback was added or taken away by hand.	adjustment
visit.created	A visit was recorded with `POST /v1/visits`.	visit
reward.unlocked	A stamp card was completed.	reward
reward.redeemed	A stamp reward was given.	reward
order.created	A guest sent an order from the QR menu.	order
order.updated	An order changed status. Includes `previous_status`.	order
menu.updated	Dishes changed through the API.	menu_change
test.ping	You 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.