☰ Мәзір · Оқиғалар
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 арқылы оқыңыз. Жаңа түрлер қосылады. Белгісіз түрлерді елемеңіз. Жеткізу, қолтаңбалар мен қайталаулар Вебхуктар нұсқаулығында сипатталған.