☰ Меню · События
Справочник API

События

Все типы событий: когда они отправляются и что лежит в 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",
      ...
    }
  }
}
ТипКогда отправляетсяdata.object
member.createdГость зарегистрирован через API, например кассой или киоском.member
member.updatedИзменился профиль или номер карты.member
member.scannedУстройство вызвало POST /v1/scans, и участник найден.scan
transaction.completedЧек проведён через API любой интеграцией заведения.transaction
transaction.voidedЧек отменён.transaction
transaction.refundedПо чеку оформлен частичный возврат.refund
balance.adjustedКэшбэк начислен или снят вручную.adjustment
visit.createdВизит зафиксирован через POST /v1/visits.visit
reward.unlockedКарта штампов заполнена.reward
reward.redeemedНаграда за штампы выдана.reward
order.createdГость отправил заказ из QR-меню.order
order.updatedЗаказ сменил статус. Содержит previous_status.order
menu.updatedБлюда изменены через API.menu_change
test.pingВы нажали «Отправить тест» или вызвали тестовый эндпоинт.ping

События отправляются для изменений, сделанных через API. Изменения из собственного кассового приложения заведения пока не отправляются, их можно получить через GET /v1/members/{member}/history. Типы событий будут добавляться. Неизвестные типы игнорируйте. Доставка, подписи и повторы описаны в руководстве по вебхукам.