☰ Меню · Події
Довідник 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. Нові типи з’являтимуться. Ігноруйте типи, яких ви не знаєте. Доставку, підписи та повтори описано в посібнику з вебхуків.