☰ Menú · Eventos
Referencia de la API

Eventos

Cada tipo de evento, qué lo dispara y qué contiene 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",
      ...
    }
  }
}
TipoSe envía cuandodata.object
member.createdSe inscribió a un cliente a través de la API, por ejemplo desde una caja o un quiosco.member
member.updatedCambió el perfil o el número de tarjeta.member
member.scannedUn dispositivo llamó a POST /v1/scans y se encontró al socio.scan
transaction.completedSe aplicó un ticket a través de la API, desde cualquier integración del local.transaction
transaction.voidedSe anuló un ticket.transaction
transaction.refundedSe devolvió una parte de un ticket.refund
balance.adjustedSe sumó o restó cashback a mano.adjustment
visit.createdSe registró una visita con POST /v1/visits.visit
reward.unlockedSe completó una tarjeta de sellos.reward
reward.redeemedSe entregó una recompensa de sellos.reward
order.createdUn cliente envió un pedido desde la carta QR.order
order.updatedUn pedido cambió de estado. Incluye previous_status.order
menu.updatedCambiaron platos a través de la API.menu_change
test.pingPulsaste Enviar prueba o llamaste al endpoint de prueba.ping

Los eventos se envían por los cambios hechos a través de la API. Los cambios hechos en la app de caja del propio local todavía no se envían; consúltalos con GET /v1/members/{member}/history. Se añadirán más tipos. Ignora los tipos que no conozcas. La entrega, las firmas y los reintentos se describen en la guía de webhooks.