☰ Meniu · Evenimente
Referință API
Evenimente
Toate tipurile de evenimente, ce le declanșează și ce conține 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",
...
}
}
}| Tip | Trimis când | data.object |
|---|---|---|
| member.created | Un oaspete a fost înscris prin API, de exemplu de o casă sau un chioșc. | member |
| member.updated | S-a schimbat profilul sau numărul cardului. | member |
| member.scanned | Un dispozitiv a apelat POST /v1/scans și membrul a fost găsit. | scan |
| transaction.completed | Un bon a fost aplicat prin API, de oricare integrare a localului. | transaction |
| transaction.voided | Un bon a fost anulat. | transaction |
| transaction.refunded | O parte dintr-un bon a fost returnată. | refund |
| balance.adjusted | Cashback-ul a fost adăugat sau scăzut manual. | adjustment |
| visit.created | O vizită a fost înregistrată cu POST /v1/visits. | visit |
| reward.unlocked | Un card de ștampile a fost completat. | reward |
| reward.redeemed | A fost acordată o recompensă pentru ștampile. | reward |
| order.created | Un oaspete a trimis o comandă din meniul QR. | order |
| order.updated | O comandă și-a schimbat statusul. Include previous_status. | order |
| menu.updated | Preparatele au fost modificate prin API. | menu_change |
| test.ping | Ai apăsat Test sau ai apelat endpointul de test. | ping |
Evenimentele se trimit pentru modificările făcute prin API. Modificările făcute în aplicația de casă a localului nu sunt trimise deocamdată; citește-le cu GET /v1/members/{member}/history. Vor fi adăugate și alte tipuri. Ignoră tipurile pe care nu le cunoști. Livrarea, semnăturile și reîncercările sunt descrise în ghidul Webhook-uri.