API FlavosoWebhooks et événementsTypes d'événements

Types d'événements

Chaque type d'événement avec sa description, le droit requis, les champs dans data et un exemple d'enveloppe.

Vue d'ensemble

Un événement est créé exactement une fois par changement, que celui-ci ait eu lieu dans le tableau de bord, sur l'écran de cuisine, dans l'application mobile, à l'imprimante de tickets ou via l'API. Vous choisissez dans la console les types que reçoit votre application ; pour GET /events, avec types.

Votre programme devrait ignorer les types qu'il ne connaît pas.

Événements	Droit requis
`order.*`	`orders:read`
`reservation.*`	`reservations:read`
`menu.*`	`menu:read`
`store.*`	`store:read`
`app.*`	aucun, seulement la connexion elle-même

Commandes

order.created

Une nouvelle commande est arrivée : immédiatement avec paiement sur place, une fois le paiement confirmé avec paiement en ligne. Une seule fois par commande.

Droit requis: orders:read

Champs dans data

objectOrderobligatoire
The order when the event was first read. Values that belong to a single app (external_id, acknowledged_at) are always null in events: the envelope is built once and sent the same to every receiver. Retrieve the object to see yours.
Champs contenus (20)
- objectstringobligatoire
  Always order.
  Valeurs:"order"
- idstring (uuid)obligatoire
  The order.
- codestringobligatoire
  Short code the guest sees and says at the counter, e.g. K7Q2M9.
- external_idstringobligatoirepeut être null
  Your app's reference set with POST /orders/{id}/acknowledge; null when none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- typestringobligatoire
  How the guest gets the order.
  Valeurs:"pickup""delivery""dine_in"
- sourcestringobligatoire
  Where it was placed: table via a table's QR code, app in the Flavoso app by a signed-in guest, storefront everything else (the restaurant's ordering page, the app without sign-in).
  Valeurs:"storefront""table""app"
- statusstringobligatoire
  Where the order is now. Restaurants may skip statuses, see GET /store.
  Valeurs:"pending""confirmed""preparing""ready""completed""cancelled"
- created_atstring (date-time)obligatoire
  When the order was placed. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- acknowledged_atstring (date-time)obligatoirepeut être null
  When your app first acknowledged the order (POST /orders/{id}/acknowledge); null when not yet. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- requested_forstring (date-time)obligatoirepeut être null
  Pickup or delivery time chosen by the guest (pre-order); null means as soon as possible.
- currencystringobligatoire
  ISO 4217, e.g. EUR.
- amountsobjectobligatoire
  The amounts of the order, in cents.
  Champs contenus (6)
  - subtotalintegerobligatoire
    Sum of the items. Integer amount in the smallest currency unit (cents).
  - delivery_feeintegerobligatoire
    Delivery fee. Integer amount in the smallest currency unit (cents).
  - service_feeintegerobligatoire
    Service fee. Integer amount in the smallest currency unit (cents).
  - discountintegerobligatoire
    Discount (stamp card), already subtracted. Integer amount in the smallest currency unit (cents).
  - tipintegerobligatoire
    Tip. Pass-through, not revenue. Integer amount in the smallest currency unit (cents).
  - totalintegerobligatoire
    subtotal + delivery_fee + service_fee − discount + tip. Integer amount in the smallest currency unit (cents).
- taxobjectobligatoire
  VAT per rate of total − tip (items, fees, minus discount), computed like the restaurant's accounting export: discounts and delivery fees spread over the rates as the restaurant set it.
  Champs contenus (2)
  - includedbooleanobligatoire
    Always true: prices include VAT.
    Valeurs:true
  - linesTaxLine[]obligatoire
    One line per rate, ascending, lines without rate last. The gross amounts add up to total − tip.
    Champs contenus (4)
    rate_bpsintegerobligatoirepeut être null
    The rate in basis points (700 = 7 %). null: no rate was stored for this part (not the same as 0 %); then net and tax are null.
    grossintegerobligatoire
    Gross amount at this rate. Integer amount in the smallest currency unit (cents).
    netintegerobligatoirepeut être null
    gross − tax, in cents. null when rate_bps is null.
    taxintegerobligatoirepeut être null
    VAT contained in gross: round(gross × rate / (10000 + rate)), in cents. null when rate_bps is null.
- paymentobjectobligatoire
  How and whether it is paid.
  Champs contenus (3)
  - methodstringobligatoire
    online: paid at checkout. on_site: paid at pickup, delivery or the table.
    Valeurs:"online""on_site"
  - statusstringobligatoire
    paid once the online payment is confirmed. open: to be paid on site; it stays open, because Flavoso does not record payments on site.
    Valeurs:"paid""open"
  - paid_atstring (date-time)obligatoirepeut être null
    When it was paid; null while open.
- customerobjectobligatoirepeut être null
  Only what is needed to hand the order over (data minimisation): no e-mail, and no phone for dine-in. null when neither is known.
  Champs contenus (2)
  - namestringobligatoirepeut être null
    The guest's name.
  - phonestringobligatoirepeut être null
    Phone for questions; null for dine-in.
- deliveryobjectobligatoirepeut être null
  The delivery address; null unless type is delivery.
  Champs contenus (3)
  - addressstringobligatoirepeut être null
    Street and number.
  - postal_codestringobligatoirepeut être null
    Postal code.
  - citystringobligatoirepeut être null
    City.
- tableobjectobligatoirepeut être null
  The table of a dine-in order; null otherwise.
  Champs contenus (2)
  - idstring (uuid)obligatoire
    The table (GET /tables).
  - labelstringobligatoirepeut être null
    The table's name, e.g. 4.
- notestringobligatoirepeut être null
  Guest's note for the kitchen (allergies!).
- itemsOrderItem[]obligatoire
  The lines.
  Champs contenus (8)
  - idstring (uuid)obligatoire
    The line.
  - product_idstring (uuid)obligatoirepeut être null
    The dish (GET /menu/products/{id}); null when it was deleted since.
  - namestringobligatoire
    Name at the time of ordering.
  - quantityintegerobligatoire
    How many.
    min 1
  - unit_priceintegerobligatoire
    Price of one unit including options. Integer amount in the smallest currency unit (cents).
  - line_totalintegerobligatoire
    unit_price × quantity. Integer amount in the smallest currency unit (cents).
  - tax_rate_bpsintegerobligatoirepeut être null
    VAT rate frozen at order time, in basis points (700 = 7 %). null when the restaurant has not set rates.
  - optionsobject[]obligatoire
    The chosen options (extras, sizes), as ordered. Name, surcharge and group name are frozen at order time; the ids point to the menu (GET /menu/options/{id}) as long as the option exists.
    Champs contenus (5)
    idstring (uuid)obligatoirepeut être null
    The option (GET /menu/options/{id}); with it you find your own modifier through its external_id. null for orders placed before 8 October 2026.
    namestringobligatoire
    Name of the option.
    price_deltaintegerobligatoire
    Surcharge of this option, per unit. Integer amount in the smallest currency unit (cents).
    group_idstring (uuid)obligatoirepeut être null
    The option group the option was chosen in (GET /menu/option-groups/{id}). null for orders placed before 8 October 2026.
    group_namestringobligatoirepeut être null
    Name of that group at order time, e.g. Extras or Size. null for orders placed before 8 October 2026.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "order.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "order",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "external_id": "ART-1001",
      "type": "pickup",
      "source": "storefront",
      "status": "pending",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "acknowledged_at": "2026-10-04T17:44:59.942Z",
      "requested_for": "2026-10-04T17:44:59.942Z",
      "currency": "EUR",
      "amounts": {
        "subtotal": 1290,
        "delivery_fee": 1290,
        "service_fee": 1290,
        "discount": 1290,
        "tip": 1290,
        "total": 1290
      },
      "tax": {
        "included": true,
        "lines": [
          {
            "rate_bps": 700,
            "gross": 1290,
            "net": 1290,
            "tax": 1290
          }
        ]
      },
      "payment": {
        "method": "online",
        "status": "paid",
        "paid_at": "2026-10-04T17:44:59.942Z"
      },
      "customer": {
        "name": "string",
        "phone": "string"
      },
      "delivery": {
        "address": "string",
        "postal_code": "string",
        "city": "string"
      },
      "table": {
        "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
        "label": "string"
      },
      "note": "string",
      "items": [
        {
          "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
          "product_id": "6818680c-4376-47b0-a818-680c4376d7b0",
          "name": "string",
          "quantity": 1,
          "unit_price": 1290,
          "line_total": 1290,
          "tax_rate_bps": 700,
          "options": [
            {
              "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
              "name": "string",
              "price_delta": 1290,
              "group_id": "9594642c-e6ef-49ac-a594-642ce6efc9ac",
              "group_name": "string"
            }
          ]
        }
      ]
    }
  }
}

order.status_changed

Une commande a changé de statut, où que ce soit : tableau de bord, écran de cuisine, application mobile, imprimante de tickets ou API. previous_status indique l'ancien.

Droit requis: orders:read

Champs dans data

objectOrderobligatoire
An order. Guest data is limited to what is needed to hand it over: the name, the phone for pickup and delivery, the address for delivery, never an e-mail.
Champs contenus (20)
- objectstringobligatoire
  Always order.
  Valeurs:"order"
- idstring (uuid)obligatoire
  The order.
- codestringobligatoire
  Short code the guest sees and says at the counter, e.g. K7Q2M9.
- external_idstringobligatoirepeut être null
  Your app's reference set with POST /orders/{id}/acknowledge; null when none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- typestringobligatoire
  How the guest gets the order.
  Valeurs:"pickup""delivery""dine_in"
- sourcestringobligatoire
  Where it was placed: table via a table's QR code, app in the Flavoso app by a signed-in guest, storefront everything else (the restaurant's ordering page, the app without sign-in).
  Valeurs:"storefront""table""app"
- statusstringobligatoire
  Where the order is now. Restaurants may skip statuses, see GET /store.
  Valeurs:"pending""confirmed""preparing""ready""completed""cancelled"
- created_atstring (date-time)obligatoire
  When the order was placed. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- acknowledged_atstring (date-time)obligatoirepeut être null
  When your app first acknowledged the order (POST /orders/{id}/acknowledge); null when not yet. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- requested_forstring (date-time)obligatoirepeut être null
  Pickup or delivery time chosen by the guest (pre-order); null means as soon as possible.
- currencystringobligatoire
  ISO 4217, e.g. EUR.
- amountsobjectobligatoire
  The amounts of the order, in cents.
  Champs contenus (6)
  - subtotalintegerobligatoire
    Sum of the items. Integer amount in the smallest currency unit (cents).
  - delivery_feeintegerobligatoire
    Delivery fee. Integer amount in the smallest currency unit (cents).
  - service_feeintegerobligatoire
    Service fee. Integer amount in the smallest currency unit (cents).
  - discountintegerobligatoire
    Discount (stamp card), already subtracted. Integer amount in the smallest currency unit (cents).
  - tipintegerobligatoire
    Tip. Pass-through, not revenue. Integer amount in the smallest currency unit (cents).
  - totalintegerobligatoire
    subtotal + delivery_fee + service_fee − discount + tip. Integer amount in the smallest currency unit (cents).
- taxobjectobligatoire
  VAT per rate of total − tip (items, fees, minus discount), computed like the restaurant's accounting export: discounts and delivery fees spread over the rates as the restaurant set it.
  Champs contenus (2)
  - includedbooleanobligatoire
    Always true: prices include VAT.
    Valeurs:true
  - linesTaxLine[]obligatoire
    One line per rate, ascending, lines without rate last. The gross amounts add up to total − tip.
    Champs contenus (4)
    rate_bpsintegerobligatoirepeut être null
    The rate in basis points (700 = 7 %). null: no rate was stored for this part (not the same as 0 %); then net and tax are null.
    grossintegerobligatoire
    Gross amount at this rate. Integer amount in the smallest currency unit (cents).
    netintegerobligatoirepeut être null
    gross − tax, in cents. null when rate_bps is null.
    taxintegerobligatoirepeut être null
    VAT contained in gross: round(gross × rate / (10000 + rate)), in cents. null when rate_bps is null.
- paymentobjectobligatoire
  How and whether it is paid.
  Champs contenus (3)
  - methodstringobligatoire
    online: paid at checkout. on_site: paid at pickup, delivery or the table.
    Valeurs:"online""on_site"
  - statusstringobligatoire
    paid once the online payment is confirmed. open: to be paid on site; it stays open, because Flavoso does not record payments on site.
    Valeurs:"paid""open"
  - paid_atstring (date-time)obligatoirepeut être null
    When it was paid; null while open.
- customerobjectobligatoirepeut être null
  Only what is needed to hand the order over (data minimisation): no e-mail, and no phone for dine-in. null when neither is known.
  Champs contenus (2)
  - namestringobligatoirepeut être null
    The guest's name.
  - phonestringobligatoirepeut être null
    Phone for questions; null for dine-in.
- deliveryobjectobligatoirepeut être null
  The delivery address; null unless type is delivery.
  Champs contenus (3)
  - addressstringobligatoirepeut être null
    Street and number.
  - postal_codestringobligatoirepeut être null
    Postal code.
  - citystringobligatoirepeut être null
    City.
- tableobjectobligatoirepeut être null
  The table of a dine-in order; null otherwise.
  Champs contenus (2)
  - idstring (uuid)obligatoire
    The table (GET /tables).
  - labelstringobligatoirepeut être null
    The table's name, e.g. 4.
- notestringobligatoirepeut être null
  Guest's note for the kitchen (allergies!).
- itemsOrderItem[]obligatoire
  The lines.
  Champs contenus (8)
  - idstring (uuid)obligatoire
    The line.
  - product_idstring (uuid)obligatoirepeut être null
    The dish (GET /menu/products/{id}); null when it was deleted since.
  - namestringobligatoire
    Name at the time of ordering.
  - quantityintegerobligatoire
    How many.
    min 1
  - unit_priceintegerobligatoire
    Price of one unit including options. Integer amount in the smallest currency unit (cents).
  - line_totalintegerobligatoire
    unit_price × quantity. Integer amount in the smallest currency unit (cents).
  - tax_rate_bpsintegerobligatoirepeut être null
    VAT rate frozen at order time, in basis points (700 = 7 %). null when the restaurant has not set rates.
  - optionsobject[]obligatoire
    The chosen options (extras, sizes), as ordered. Name, surcharge and group name are frozen at order time; the ids point to the menu (GET /menu/options/{id}) as long as the option exists.
    Champs contenus (5)
    idstring (uuid)obligatoirepeut être null
    The option (GET /menu/options/{id}); with it you find your own modifier through its external_id. null for orders placed before 8 October 2026.
    namestringobligatoire
    Name of the option.
    price_deltaintegerobligatoire
    Surcharge of this option, per unit. Integer amount in the smallest currency unit (cents).
    group_idstring (uuid)obligatoirepeut être null
    The option group the option was chosen in (GET /menu/option-groups/{id}). null for orders placed before 8 October 2026.
    group_namestringobligatoirepeut être null
    Name of that group at order time, e.g. Extras or Size. null for orders placed before 8 October 2026.
previous_statusstringobligatoire
The status before this change.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "order.status_changed",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "order",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "external_id": "ART-1001",
      "type": "pickup",
      "source": "storefront",
      "status": "pending",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "acknowledged_at": "2026-10-04T17:44:59.942Z",
      "requested_for": "2026-10-04T17:44:59.942Z",
      "currency": "EUR",
      "amounts": {
        "subtotal": 1290,
        "delivery_fee": 1290,
        "service_fee": 1290,
        "discount": 1290,
        "tip": 1290,
        "total": 1290
      },
      "tax": {
        "included": true,
        "lines": [
          {
            "rate_bps": 700,
            "gross": 1290,
            "net": 1290,
            "tax": 1290
          }
        ]
      },
      "payment": {
        "method": "online",
        "status": "paid",
        "paid_at": "2026-10-04T17:44:59.942Z"
      },
      "customer": {
        "name": "string",
        "phone": "string"
      },
      "delivery": {
        "address": "string",
        "postal_code": "string",
        "city": "string"
      },
      "table": {
        "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
        "label": "string"
      },
      "note": "string",
      "items": [
        {
          "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
          "product_id": "6818680c-4376-47b0-a818-680c4376d7b0",
          "name": "string",
          "quantity": 1,
          "unit_price": 1290,
          "line_total": 1290,
          "tax_rate_bps": 700,
          "options": [
            {
              "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
              "name": "string",
              "price_delta": 1290,
              "group_id": "9594642c-e6ef-49ac-a594-642ce6efc9ac",
              "group_name": "string"
            }
          ]
        }
      ]
    },
    "previous_status": "string"
  }
}

order.cancelled

Une commande a été annulée ou refusée. Envoyé en plus de order.status_changed.

Droit requis: orders:read

Champs dans data

objectOrderobligatoire
An order. Guest data is limited to what is needed to hand it over: the name, the phone for pickup and delivery, the address for delivery, never an e-mail.
Champs contenus (20)
- objectstringobligatoire
  Always order.
  Valeurs:"order"
- idstring (uuid)obligatoire
  The order.
- codestringobligatoire
  Short code the guest sees and says at the counter, e.g. K7Q2M9.
- external_idstringobligatoirepeut être null
  Your app's reference set with POST /orders/{id}/acknowledge; null when none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- typestringobligatoire
  How the guest gets the order.
  Valeurs:"pickup""delivery""dine_in"
- sourcestringobligatoire
  Where it was placed: table via a table's QR code, app in the Flavoso app by a signed-in guest, storefront everything else (the restaurant's ordering page, the app without sign-in).
  Valeurs:"storefront""table""app"
- statusstringobligatoire
  Where the order is now. Restaurants may skip statuses, see GET /store.
  Valeurs:"pending""confirmed""preparing""ready""completed""cancelled"
- created_atstring (date-time)obligatoire
  When the order was placed. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- acknowledged_atstring (date-time)obligatoirepeut être null
  When your app first acknowledged the order (POST /orders/{id}/acknowledge); null when not yet. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- requested_forstring (date-time)obligatoirepeut être null
  Pickup or delivery time chosen by the guest (pre-order); null means as soon as possible.
- currencystringobligatoire
  ISO 4217, e.g. EUR.
- amountsobjectobligatoire
  The amounts of the order, in cents.
  Champs contenus (6)
  - subtotalintegerobligatoire
    Sum of the items. Integer amount in the smallest currency unit (cents).
  - delivery_feeintegerobligatoire
    Delivery fee. Integer amount in the smallest currency unit (cents).
  - service_feeintegerobligatoire
    Service fee. Integer amount in the smallest currency unit (cents).
  - discountintegerobligatoire
    Discount (stamp card), already subtracted. Integer amount in the smallest currency unit (cents).
  - tipintegerobligatoire
    Tip. Pass-through, not revenue. Integer amount in the smallest currency unit (cents).
  - totalintegerobligatoire
    subtotal + delivery_fee + service_fee − discount + tip. Integer amount in the smallest currency unit (cents).
- taxobjectobligatoire
  VAT per rate of total − tip (items, fees, minus discount), computed like the restaurant's accounting export: discounts and delivery fees spread over the rates as the restaurant set it.
  Champs contenus (2)
  - includedbooleanobligatoire
    Always true: prices include VAT.
    Valeurs:true
  - linesTaxLine[]obligatoire
    One line per rate, ascending, lines without rate last. The gross amounts add up to total − tip.
    Champs contenus (4)
    rate_bpsintegerobligatoirepeut être null
    The rate in basis points (700 = 7 %). null: no rate was stored for this part (not the same as 0 %); then net and tax are null.
    grossintegerobligatoire
    Gross amount at this rate. Integer amount in the smallest currency unit (cents).
    netintegerobligatoirepeut être null
    gross − tax, in cents. null when rate_bps is null.
    taxintegerobligatoirepeut être null
    VAT contained in gross: round(gross × rate / (10000 + rate)), in cents. null when rate_bps is null.
- paymentobjectobligatoire
  How and whether it is paid.
  Champs contenus (3)
  - methodstringobligatoire
    online: paid at checkout. on_site: paid at pickup, delivery or the table.
    Valeurs:"online""on_site"
  - statusstringobligatoire
    paid once the online payment is confirmed. open: to be paid on site; it stays open, because Flavoso does not record payments on site.
    Valeurs:"paid""open"
  - paid_atstring (date-time)obligatoirepeut être null
    When it was paid; null while open.
- customerobjectobligatoirepeut être null
  Only what is needed to hand the order over (data minimisation): no e-mail, and no phone for dine-in. null when neither is known.
  Champs contenus (2)
  - namestringobligatoirepeut être null
    The guest's name.
  - phonestringobligatoirepeut être null
    Phone for questions; null for dine-in.
- deliveryobjectobligatoirepeut être null
  The delivery address; null unless type is delivery.
  Champs contenus (3)
  - addressstringobligatoirepeut être null
    Street and number.
  - postal_codestringobligatoirepeut être null
    Postal code.
  - citystringobligatoirepeut être null
    City.
- tableobjectobligatoirepeut être null
  The table of a dine-in order; null otherwise.
  Champs contenus (2)
  - idstring (uuid)obligatoire
    The table (GET /tables).
  - labelstringobligatoirepeut être null
    The table's name, e.g. 4.
- notestringobligatoirepeut être null
  Guest's note for the kitchen (allergies!).
- itemsOrderItem[]obligatoire
  The lines.
  Champs contenus (8)
  - idstring (uuid)obligatoire
    The line.
  - product_idstring (uuid)obligatoirepeut être null
    The dish (GET /menu/products/{id}); null when it was deleted since.
  - namestringobligatoire
    Name at the time of ordering.
  - quantityintegerobligatoire
    How many.
    min 1
  - unit_priceintegerobligatoire
    Price of one unit including options. Integer amount in the smallest currency unit (cents).
  - line_totalintegerobligatoire
    unit_price × quantity. Integer amount in the smallest currency unit (cents).
  - tax_rate_bpsintegerobligatoirepeut être null
    VAT rate frozen at order time, in basis points (700 = 7 %). null when the restaurant has not set rates.
  - optionsobject[]obligatoire
    The chosen options (extras, sizes), as ordered. Name, surcharge and group name are frozen at order time; the ids point to the menu (GET /menu/options/{id}) as long as the option exists.
    Champs contenus (5)
    idstring (uuid)obligatoirepeut être null
    The option (GET /menu/options/{id}); with it you find your own modifier through its external_id. null for orders placed before 8 October 2026.
    namestringobligatoire
    Name of the option.
    price_deltaintegerobligatoire
    Surcharge of this option, per unit. Integer amount in the smallest currency unit (cents).
    group_idstring (uuid)obligatoirepeut être null
    The option group the option was chosen in (GET /menu/option-groups/{id}). null for orders placed before 8 October 2026.
    group_namestringobligatoirepeut être null
    Name of that group at order time, e.g. Extras or Size. null for orders placed before 8 October 2026.
previous_statusstringobligatoire
The status before the cancellation.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "order.cancelled",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "order",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "external_id": "ART-1001",
      "type": "pickup",
      "source": "storefront",
      "status": "pending",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "acknowledged_at": "2026-10-04T17:44:59.942Z",
      "requested_for": "2026-10-04T17:44:59.942Z",
      "currency": "EUR",
      "amounts": {
        "subtotal": 1290,
        "delivery_fee": 1290,
        "service_fee": 1290,
        "discount": 1290,
        "tip": 1290,
        "total": 1290
      },
      "tax": {
        "included": true,
        "lines": [
          {
            "rate_bps": 700,
            "gross": 1290,
            "net": 1290,
            "tax": 1290
          }
        ]
      },
      "payment": {
        "method": "online",
        "status": "paid",
        "paid_at": "2026-10-04T17:44:59.942Z"
      },
      "customer": {
        "name": "string",
        "phone": "string"
      },
      "delivery": {
        "address": "string",
        "postal_code": "string",
        "city": "string"
      },
      "table": {
        "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
        "label": "string"
      },
      "note": "string",
      "items": [
        {
          "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
          "product_id": "6818680c-4376-47b0-a818-680c4376d7b0",
          "name": "string",
          "quantity": 1,
          "unit_price": 1290,
          "line_total": 1290,
          "tax_rate_bps": 700,
          "options": [
            {
              "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
              "name": "string",
              "price_delta": 1290,
              "group_id": "9594642c-e6ef-49ac-a594-642ce6efc9ac",
              "group_name": "string"
            }
          ]
        }
      ]
    },
    "previous_status": "string"
  }
}

order.paid

Une commande a été payée en ligne : le prestataire de paiement a confirmé le paiement, et la commande existe à partir de là (juste après order.created). Les commandes payées sur place ne sont pas enregistrées comme payées dans Flavoso et ne déclenchent jamais cet événement.

Droit requis: orders:read

Champs dans data

objectOrderobligatoire
An order. Guest data is limited to what is needed to hand it over: the name, the phone for pickup and delivery, the address for delivery, never an e-mail.
Champs contenus (20)
- objectstringobligatoire
  Always order.
  Valeurs:"order"
- idstring (uuid)obligatoire
  The order.
- codestringobligatoire
  Short code the guest sees and says at the counter, e.g. K7Q2M9.
- external_idstringobligatoirepeut être null
  Your app's reference set with POST /orders/{id}/acknowledge; null when none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- typestringobligatoire
  How the guest gets the order.
  Valeurs:"pickup""delivery""dine_in"
- sourcestringobligatoire
  Where it was placed: table via a table's QR code, app in the Flavoso app by a signed-in guest, storefront everything else (the restaurant's ordering page, the app without sign-in).
  Valeurs:"storefront""table""app"
- statusstringobligatoire
  Where the order is now. Restaurants may skip statuses, see GET /store.
  Valeurs:"pending""confirmed""preparing""ready""completed""cancelled"
- created_atstring (date-time)obligatoire
  When the order was placed. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- acknowledged_atstring (date-time)obligatoirepeut être null
  When your app first acknowledged the order (POST /orders/{id}/acknowledge); null when not yet. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
- requested_forstring (date-time)obligatoirepeut être null
  Pickup or delivery time chosen by the guest (pre-order); null means as soon as possible.
- currencystringobligatoire
  ISO 4217, e.g. EUR.
- amountsobjectobligatoire
  The amounts of the order, in cents.
  Champs contenus (6)
  - subtotalintegerobligatoire
    Sum of the items. Integer amount in the smallest currency unit (cents).
  - delivery_feeintegerobligatoire
    Delivery fee. Integer amount in the smallest currency unit (cents).
  - service_feeintegerobligatoire
    Service fee. Integer amount in the smallest currency unit (cents).
  - discountintegerobligatoire
    Discount (stamp card), already subtracted. Integer amount in the smallest currency unit (cents).
  - tipintegerobligatoire
    Tip. Pass-through, not revenue. Integer amount in the smallest currency unit (cents).
  - totalintegerobligatoire
    subtotal + delivery_fee + service_fee − discount + tip. Integer amount in the smallest currency unit (cents).
- taxobjectobligatoire
  VAT per rate of total − tip (items, fees, minus discount), computed like the restaurant's accounting export: discounts and delivery fees spread over the rates as the restaurant set it.
  Champs contenus (2)
  - includedbooleanobligatoire
    Always true: prices include VAT.
    Valeurs:true
  - linesTaxLine[]obligatoire
    One line per rate, ascending, lines without rate last. The gross amounts add up to total − tip.
    Champs contenus (4)
    rate_bpsintegerobligatoirepeut être null
    The rate in basis points (700 = 7 %). null: no rate was stored for this part (not the same as 0 %); then net and tax are null.
    grossintegerobligatoire
    Gross amount at this rate. Integer amount in the smallest currency unit (cents).
    netintegerobligatoirepeut être null
    gross − tax, in cents. null when rate_bps is null.
    taxintegerobligatoirepeut être null
    VAT contained in gross: round(gross × rate / (10000 + rate)), in cents. null when rate_bps is null.
- paymentobjectobligatoire
  How and whether it is paid.
  Champs contenus (3)
  - methodstringobligatoire
    online: paid at checkout. on_site: paid at pickup, delivery or the table.
    Valeurs:"online""on_site"
  - statusstringobligatoire
    paid once the online payment is confirmed. open: to be paid on site; it stays open, because Flavoso does not record payments on site.
    Valeurs:"paid""open"
  - paid_atstring (date-time)obligatoirepeut être null
    When it was paid; null while open.
- customerobjectobligatoirepeut être null
  Only what is needed to hand the order over (data minimisation): no e-mail, and no phone for dine-in. null when neither is known.
  Champs contenus (2)
  - namestringobligatoirepeut être null
    The guest's name.
  - phonestringobligatoirepeut être null
    Phone for questions; null for dine-in.
- deliveryobjectobligatoirepeut être null
  The delivery address; null unless type is delivery.
  Champs contenus (3)
  - addressstringobligatoirepeut être null
    Street and number.
  - postal_codestringobligatoirepeut être null
    Postal code.
  - citystringobligatoirepeut être null
    City.
- tableobjectobligatoirepeut être null
  The table of a dine-in order; null otherwise.
  Champs contenus (2)
  - idstring (uuid)obligatoire
    The table (GET /tables).
  - labelstringobligatoirepeut être null
    The table's name, e.g. 4.
- notestringobligatoirepeut être null
  Guest's note for the kitchen (allergies!).
- itemsOrderItem[]obligatoire
  The lines.
  Champs contenus (8)
  - idstring (uuid)obligatoire
    The line.
  - product_idstring (uuid)obligatoirepeut être null
    The dish (GET /menu/products/{id}); null when it was deleted since.
  - namestringobligatoire
    Name at the time of ordering.
  - quantityintegerobligatoire
    How many.
    min 1
  - unit_priceintegerobligatoire
    Price of one unit including options. Integer amount in the smallest currency unit (cents).
  - line_totalintegerobligatoire
    unit_price × quantity. Integer amount in the smallest currency unit (cents).
  - tax_rate_bpsintegerobligatoirepeut être null
    VAT rate frozen at order time, in basis points (700 = 7 %). null when the restaurant has not set rates.
  - optionsobject[]obligatoire
    The chosen options (extras, sizes), as ordered. Name, surcharge and group name are frozen at order time; the ids point to the menu (GET /menu/options/{id}) as long as the option exists.
    Champs contenus (5)
    idstring (uuid)obligatoirepeut être null
    The option (GET /menu/options/{id}); with it you find your own modifier through its external_id. null for orders placed before 8 October 2026.
    namestringobligatoire
    Name of the option.
    price_deltaintegerobligatoire
    Surcharge of this option, per unit. Integer amount in the smallest currency unit (cents).
    group_idstring (uuid)obligatoirepeut être null
    The option group the option was chosen in (GET /menu/option-groups/{id}). null for orders placed before 8 October 2026.
    group_namestringobligatoirepeut être null
    Name of that group at order time, e.g. Extras or Size. null for orders placed before 8 October 2026.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "order.paid",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "order",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "external_id": "ART-1001",
      "type": "pickup",
      "source": "storefront",
      "status": "pending",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "acknowledged_at": "2026-10-04T17:44:59.942Z",
      "requested_for": "2026-10-04T17:44:59.942Z",
      "currency": "EUR",
      "amounts": {
        "subtotal": 1290,
        "delivery_fee": 1290,
        "service_fee": 1290,
        "discount": 1290,
        "tip": 1290,
        "total": 1290
      },
      "tax": {
        "included": true,
        "lines": [
          {
            "rate_bps": 700,
            "gross": 1290,
            "net": 1290,
            "tax": 1290
          }
        ]
      },
      "payment": {
        "method": "online",
        "status": "paid",
        "paid_at": "2026-10-04T17:44:59.942Z"
      },
      "customer": {
        "name": "string",
        "phone": "string"
      },
      "delivery": {
        "address": "string",
        "postal_code": "string",
        "city": "string"
      },
      "table": {
        "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
        "label": "string"
      },
      "note": "string",
      "items": [
        {
          "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
          "product_id": "6818680c-4376-47b0-a818-680c4376d7b0",
          "name": "string",
          "quantity": 1,
          "unit_price": 1290,
          "line_total": 1290,
          "tax_rate_bps": 700,
          "options": [
            {
              "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
              "name": "string",
              "price_delta": 1290,
              "group_id": "9594642c-e6ef-49ac-a594-642ce6efc9ac",
              "group_name": "string"
            }
          ]
        }
      ]
    }
  }
}

Réservations

reservation.created

Une nouvelle réservation a été créée, en ligne par le client ou par l'équipe.

Droit requis: reservations:read

Champs dans data

objectReservationobligatoire
A table reservation. Contact details stay in Flavoso (data minimisation); the name is enough to greet the party.
Champs contenus (14)
- objectstringobligatoire
  Always reservation.
  Valeurs:"reservation"
- idstring (uuid)obligatoire
  The reservation.
- codestringobligatoire
  Short code the guest sees.
- statusstringobligatoire
  pending is a request the restaurant still has to confirm.
  Valeurs:"pending""confirmed""declined""seated""done""cancelled""no_show"
- starts_atstring (date-time)obligatoire
  Start of the reservation. ISO 8601 in UTC (Z).
- duration_minutesintegerobligatoire
  How long the table is held.
- party_sizeintegerobligatoire
  Number of guests.
- table_idsstring (uuid)[]obligatoire
  Assigned tables (GET /tables); empty when none is assigned yet.
- sourcestringobligatoire
  Booked online by the guest, by the restaurant's staff, or through this API.
  Valeurs:"guest""staff""api"
- guest_namestringobligatoirepeut être null
  The guest's name.
- notestringobligatoirepeut être null
  The guest's wish.
- created_atstring (date-time)obligatoire
  When it was made. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- deleted_atstring (date-time)obligatoirepeut être null
  Only set in the event that reports a deletion; deleted reservations are not returned otherwise.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "reservation.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "reservation",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "status": "pending",
      "starts_at": "2026-10-04T17:44:59.942Z",
      "duration_minutes": 30,
      "party_size": 2,
      "table_ids": [
        "8ca0177d-0bbd-4c8f-aca0-177d0bbd2c8f"
      ],
      "source": "guest",
      "guest_name": "string",
      "note": "string",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "deleted_at": "2026-10-04T17:44:59.942Z"
    }
  }
}

reservation.updated

Le statut, l'heure, le nombre de personnes, la durée, les tables ou la remarque d'une réservation ont changé ; changed indique lesquels. Quand l'établissement supprime une réservation, un dernier événement arrive avec changed: ["deleted"] et deleted_at ; ensuite, elle répond 404.

Droit requis: reservations:read

Champs dans data

objectReservationobligatoire
A table reservation. Contact details stay in Flavoso (data minimisation); the name is enough to greet the party.
Champs contenus (14)
- objectstringobligatoire
  Always reservation.
  Valeurs:"reservation"
- idstring (uuid)obligatoire
  The reservation.
- codestringobligatoire
  Short code the guest sees.
- statusstringobligatoire
  pending is a request the restaurant still has to confirm.
  Valeurs:"pending""confirmed""declined""seated""done""cancelled""no_show"
- starts_atstring (date-time)obligatoire
  Start of the reservation. ISO 8601 in UTC (Z).
- duration_minutesintegerobligatoire
  How long the table is held.
- party_sizeintegerobligatoire
  Number of guests.
- table_idsstring (uuid)[]obligatoire
  Assigned tables (GET /tables); empty when none is assigned yet.
- sourcestringobligatoire
  Booked online by the guest, by the restaurant's staff, or through this API.
  Valeurs:"guest""staff""api"
- guest_namestringobligatoirepeut être null
  The guest's name.
- notestringobligatoirepeut être null
  The guest's wish.
- created_atstring (date-time)obligatoire
  When it was made. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change. ISO 8601 in UTC (Z).
- deleted_atstring (date-time)obligatoirepeut être null
  Only set in the event that reports a deletion; deleted reservations are not returned otherwise.
previous_statusstringpeut être null
The status before this change.
changedstring[]obligatoire
The fields this change touched.
Valeurs:"status""starts_at""party_size""duration_minutes""table_ids""note""deleted"

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "reservation.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "reservation",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "code": "K7Q2M9",
      "status": "pending",
      "starts_at": "2026-10-04T17:44:59.942Z",
      "duration_minutes": 30,
      "party_size": 2,
      "table_ids": [
        "8ca0177d-0bbd-4c8f-aca0-177d0bbd2c8f"
      ],
      "source": "guest",
      "guest_name": "string",
      "note": "string",
      "created_at": "2026-10-04T17:44:59.942Z",
      "updated_at": "2026-10-04T17:44:59.942Z",
      "deleted_at": "2026-10-04T17:44:59.942Z"
    },
    "previous_status": "string",
    "changed": [
      "status"
    ]
  }
}

Carte

menu.category.created

Une catégorie a été créée : dans le tableau de bord, par l'import de carte ou via l'API.

Droit requis: menu:read

Champs dans data

objectCategory
The new category.
Champs contenus (8)
- objectstringobligatoire
  Always category.
  Valeurs:"category"
- idstring (uuid)obligatoire
  The category id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this category; null if it has none. Other apps never see yours. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it.
  max 80 chars
- positionintegerobligatoire
  Sort order on the menu, ascending.
- tax_classstringobligatoirepeut être null
  Tax group for the products in it that have none of their own. null: food.
  Valeurs:"food""drink""alcohol"
- created_atstring (date-time)obligatoire
  When the category was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.category.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "category",
      "id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "external_id": "CAT-PIZZA",
      "name": "Pizza",
      "position": 2,
      "tax_class": "food",
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.category.updated

Une catégorie a changé de nom, de position ou de groupe fiscal ; changed liste les champs, previous leurs anciennes valeurs.

Droit requis: menu:read

Champs dans data

objectCategory
The category after this change. The fields in changed show the state of this event; a later change has its own event.
Champs contenus (8)
- objectstringobligatoire
  Always category.
  Valeurs:"category"
- idstring (uuid)obligatoire
  The category id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this category; null if it has none. Other apps never see yours. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it.
  max 80 chars
- positionintegerobligatoire
  Sort order on the menu, ascending.
- tax_classstringobligatoirepeut être null
  Tax group for the products in it that have none of their own. null: food.
  Valeurs:"food""drink""alcohol"
- created_atstring (date-time)obligatoire
  When the category was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).
changedstring[]
The fields that changed: name, position, tax_class, tax_rates.
Valeurs:"name""position""tax_class""tax_rates"
previousobject
The earlier value of every field in changed (except tax_rates), and always nothing else.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.category.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "category",
      "id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "external_id": "CAT-PIZZA",
      "name": "Pizza",
      "position": 2,
      "tax_class": "food",
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    },
    "changed": [
      "name"
    ],
    "previous": {}
  }
}

menu.category.deleted

Une catégorie a été supprimée. object la montre telle qu'elle était avant. Ses plats ont été supprimés avec elle (chacun avec son propre menu.product.deleted) ou déplacés vers « Sans catégorie » (menu.product.updated avec category_id dans changed).

Droit requis: menu:read

Champs dans data

objectCategory
The category as it was right before it was deleted. Requests for its id answer 404 from now on.
Champs contenus (8)
- objectstringobligatoire
  Always category.
  Valeurs:"category"
- idstring (uuid)obligatoire
  The category id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this category; null if it has none. Other apps never see yours. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it.
  max 80 chars
- positionintegerobligatoire
  Sort order on the menu, ascending.
- tax_classstringobligatoirepeut être null
  Tax group for the products in it that have none of their own. null: food.
  Valeurs:"food""drink""alcohol"
- created_atstring (date-time)obligatoire
  When the category was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.category.deleted",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "category",
      "id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "external_id": "CAT-PIZZA",
      "name": "Pizza",
      "position": 2,
      "tax_class": "food",
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.product.created

Un plat a été créé : dans le tableau de bord, par l'import de carte ou via l'API.

Droit requis: menu:read

Champs dans data

objectProduct
The new product.
Champs contenus (17)
- objectstringobligatoire
  Always product.
  Valeurs:"product"
- idstring (uuid)obligatoire
  The product id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this product; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- category_idstring (uuid)obligatoirepeut être null
  Its category; null: no category.
- namestringobligatoire
  Name as the guest sees it.
  max 200 chars
- descriptionstringobligatoirepeut être null
  Description as the guest sees it.
  max 2000 chars
- priceintegerobligatoire
  Price including VAT, without options. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out: guests cannot order it until it is available again.
- positionintegerobligatoire
  Sort order within its category, ascending.
- allergensstring[]obligatoire
  The 14 EU allergens as keys: gluten, crustaceans, eggs, fish, peanuts, soybeans, milk, nuts, celery, mustard, sesame, sulphites, lupin, molluscs. Common names in German, English, French, Spanish and Italian are mapped to the key (Soja → soybeans). Anything else is kept as the restaurant's own label and shown verbatim (at most 20 such labels, 40 characters each).
  max 34 items
- dietsstring[]obligatoire
  Diet marks: vegetarian, vegan, gluten_free, lactose_free, halal, kosher (Gluten-free is mapped to gluten_free). Anything else is kept as the restaurant's own label, e.g. "gluten-free on request" (at most 14 such labels, 60 characters each). Never mixed with allergens.
- image_urlstring (uri)obligatoirepeut être null
  The product photo as Flavoso serves it; null: none.
- tax_classstringobligatoirepeut être null
  The product's own tax group; null: its category's, else food.
  Valeurs:"food""drink""alcohol"
- tax_ratesTaxRatesobligatoire
  The resolved VAT rates in basis points.
  Champs contenus (2)
  - dine_in_bpsintegerobligatoirepeut être null
    Rate when eaten in (table orders).
  - takeaway_bpsintegerobligatoirepeut être null
    Rate for pickup and delivery.
- option_group_idsstring (uuid)[]obligatoire
  Its option groups in the order the guest sees them: groups that belong to this product only first, then shared groups from the option library.
- created_atstring (date-time)obligatoire
  When the product was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields, including its option groups. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.product.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "product",
      "id": "3c9a7e5d-1b2f-4a6c-8d0e-7f5a3b1c9e2d",
      "external_id": "PLU-1001",
      "category_id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "name": "Pizza Margherita",
      "description": "Tomato, mozzarella, basil",
      "price": 890,
      "available": true,
      "position": 0,
      "allergens": [
        "gluten",
        "milk"
      ],
      "diets": [
        "vegetarian"
      ],
      "image_url": "https://api.flavoso.com/storage/v1/object/public/tenant-assets/products/6f1e2d3c-4b5a-4c69-8d7e-0f1a2b3c4d5e/api-4f3a9c0d5b1e7a2c8d6f0e1b3a5c7d9e.jpg",
      "tax_class": "food",
      "tax_rates": {
        "dine_in_bps": 700,
        "takeaway_bps": 700
      },
      "option_group_ids": [
        "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170"
      ],
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.product.updated

Un plat a changé : épuisé, de retour, prix, nom, description, catégorie, position, allergènes, régimes, image, groupe fiscal ou groupes d'options. changed liste les champs, previous leurs anciennes valeurs et toujours available et price.

Droit requis: menu:read

Champs dans data

objectProduct
The product after this change. The fields in changed show the state of this event; a later change has its own event.
Champs contenus (17)
- objectstringobligatoire
  Always product.
  Valeurs:"product"
- idstring (uuid)obligatoire
  The product id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this product; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- category_idstring (uuid)obligatoirepeut être null
  Its category; null: no category.
- namestringobligatoire
  Name as the guest sees it.
  max 200 chars
- descriptionstringobligatoirepeut être null
  Description as the guest sees it.
  max 2000 chars
- priceintegerobligatoire
  Price including VAT, without options. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out: guests cannot order it until it is available again.
- positionintegerobligatoire
  Sort order within its category, ascending.
- allergensstring[]obligatoire
  The 14 EU allergens as keys: gluten, crustaceans, eggs, fish, peanuts, soybeans, milk, nuts, celery, mustard, sesame, sulphites, lupin, molluscs. Common names in German, English, French, Spanish and Italian are mapped to the key (Soja → soybeans). Anything else is kept as the restaurant's own label and shown verbatim (at most 20 such labels, 40 characters each).
  max 34 items
- dietsstring[]obligatoire
  Diet marks: vegetarian, vegan, gluten_free, lactose_free, halal, kosher (Gluten-free is mapped to gluten_free). Anything else is kept as the restaurant's own label, e.g. "gluten-free on request" (at most 14 such labels, 60 characters each). Never mixed with allergens.
- image_urlstring (uri)obligatoirepeut être null
  The product photo as Flavoso serves it; null: none.
- tax_classstringobligatoirepeut être null
  The product's own tax group; null: its category's, else food.
  Valeurs:"food""drink""alcohol"
- tax_ratesTaxRatesobligatoire
  The resolved VAT rates in basis points.
  Champs contenus (2)
  - dine_in_bpsintegerobligatoirepeut être null
    Rate when eaten in (table orders).
  - takeaway_bpsintegerobligatoirepeut être null
    Rate for pickup and delivery.
- option_group_idsstring (uuid)[]obligatoire
  Its option groups in the order the guest sees them: groups that belong to this product only first, then shared groups from the option library.
- created_atstring (date-time)obligatoire
  When the product was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields, including its option groups. ISO 8601 in UTC (Z).
changedstring[]
The fields that changed: category_id, name, description, price, available, position, allergens, diets, image_url, tax_class, tax_rates, option_group_ids.
Valeurs:"category_id""name""description""price""available""position""allergens""diets""image_url""tax_class""tax_rates""option_group_ids"
previousobject
The earlier value of every field in changed (except tax_rates and option_group_ids), and always available and price (as before this change).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.product.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "product",
      "id": "3c9a7e5d-1b2f-4a6c-8d0e-7f5a3b1c9e2d",
      "external_id": "PLU-1001",
      "category_id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "name": "Pizza Margherita",
      "description": "Tomato, mozzarella, basil",
      "price": 890,
      "available": true,
      "position": 0,
      "allergens": [
        "gluten",
        "milk"
      ],
      "diets": [
        "vegetarian"
      ],
      "image_url": "https://api.flavoso.com/storage/v1/object/public/tenant-assets/products/6f1e2d3c-4b5a-4c69-8d7e-0f1a2b3c4d5e/api-4f3a9c0d5b1e7a2c8d6f0e1b3a5c7d9e.jpg",
      "tax_class": "food",
      "tax_rates": {
        "dine_in_bps": 700,
        "takeaway_bps": 700
      },
      "option_group_ids": [
        "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170"
      ],
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    },
    "changed": [
      "category_id"
    ],
    "previous": {}
  }
}

menu.product.deleted

Un plat a été supprimé. object le montre tel qu'il était avant. Les commandes conservent leurs lignes avec le nom de l'époque ; leur product_id devient null.

Droit requis: menu:read

Champs dans data

objectProduct
The product as it was right before it was deleted. Requests for its id answer 404 from now on.
Champs contenus (17)
- objectstringobligatoire
  Always product.
  Valeurs:"product"
- idstring (uuid)obligatoire
  The product id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this product; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- category_idstring (uuid)obligatoirepeut être null
  Its category; null: no category.
- namestringobligatoire
  Name as the guest sees it.
  max 200 chars
- descriptionstringobligatoirepeut être null
  Description as the guest sees it.
  max 2000 chars
- priceintegerobligatoire
  Price including VAT, without options. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out: guests cannot order it until it is available again.
- positionintegerobligatoire
  Sort order within its category, ascending.
- allergensstring[]obligatoire
  The 14 EU allergens as keys: gluten, crustaceans, eggs, fish, peanuts, soybeans, milk, nuts, celery, mustard, sesame, sulphites, lupin, molluscs. Common names in German, English, French, Spanish and Italian are mapped to the key (Soja → soybeans). Anything else is kept as the restaurant's own label and shown verbatim (at most 20 such labels, 40 characters each).
  max 34 items
- dietsstring[]obligatoire
  Diet marks: vegetarian, vegan, gluten_free, lactose_free, halal, kosher (Gluten-free is mapped to gluten_free). Anything else is kept as the restaurant's own label, e.g. "gluten-free on request" (at most 14 such labels, 60 characters each). Never mixed with allergens.
- image_urlstring (uri)obligatoirepeut être null
  The product photo as Flavoso serves it; null: none.
- tax_classstringobligatoirepeut être null
  The product's own tax group; null: its category's, else food.
  Valeurs:"food""drink""alcohol"
- tax_ratesTaxRatesobligatoire
  The resolved VAT rates in basis points.
  Champs contenus (2)
  - dine_in_bpsintegerobligatoirepeut être null
    Rate when eaten in (table orders).
  - takeaway_bpsintegerobligatoirepeut être null
    Rate for pickup and delivery.
- option_group_idsstring (uuid)[]obligatoire
  Its option groups in the order the guest sees them: groups that belong to this product only first, then shared groups from the option library.
- created_atstring (date-time)obligatoire
  When the product was created. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its fields, including its option groups. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.product.deleted",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "product",
      "id": "3c9a7e5d-1b2f-4a6c-8d0e-7f5a3b1c9e2d",
      "external_id": "PLU-1001",
      "category_id": "8f6b2c1e-4d3a-4b5f-9c7d-2e1a0b9c8d7e",
      "name": "Pizza Margherita",
      "description": "Tomato, mozzarella, basil",
      "price": 890,
      "available": true,
      "position": 0,
      "allergens": [
        "gluten",
        "milk"
      ],
      "diets": [
        "vegetarian"
      ],
      "image_url": "https://api.flavoso.com/storage/v1/object/public/tenant-assets/products/6f1e2d3c-4b5a-4c69-8d7e-0f1a2b3c4d5e/api-4f3a9c0d5b1e7a2c8d6f0e1b3a5c7d9e.jpg",
      "tax_class": "food",
      "tax_rates": {
        "dine_in_bps": 700,
        "takeaway_bps": 700
      },
      "option_group_ids": [
        "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170"
      ],
      "created_at": "2026-10-06T09:12:00.000Z",
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.option_group.created

Un groupe d'options a été créé : un groupe partagé ou le groupe propre d'un plat.

Droit requis: menu:read

Champs dans data

objectOptionGroup
The new option group.
Champs contenus (10)
- objectstringobligatoire
  Always option_group.
  Valeurs:"option_group"
- idstring (uuid)obligatoire
  The option group id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this group; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it, e.g. Size, Extras.
  max 120 chars
- min_selectintegerobligatoire
  How many options the guest must pick at least (0 = optional).
  0 to 20
- max_selectintegerobligatoire
  How many options the guest may pick at most.
  1 to 20
- positionintegerobligatoire
  Sort order among groups.
- product_idstring (uuid)obligatoirepeut être null
  The product this group belongs to only; null for a shared group.
- optionsOption[]obligatoire
  Its options in order, including sold-out ones.
  Champs contenus (9)
  - objectstringobligatoire
    Always option.
    Valeurs:"option"
  - idstring (uuid)obligatoire
    The option id.
  - external_idstringobligatoirepeut être null
    Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
    1 to 100 chars
  - group_idstring (uuid)obligatoire
    The option group it belongs to.
  - namestringobligatoire
    Name as the guest sees it.
    max 120 chars
  - price_deltaintegerobligatoire
    Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
  - availablebooleanobligatoire
    false = sold out on every product that uses the group.
  - positionintegerobligatoire
    Sort order within the group.
  - updated_atstring (date-time)obligatoire
    Last change of one of its fields. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its own fields (not of its options). ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option_group.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option_group",
      "id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "external_id": "GRP-EXTRAS",
      "name": "Extras",
      "min_select": 0,
      "max_select": 3,
      "position": 0,
      "product_id": null,
      "options": [
        {
          "object": "option",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "external_id": "MOD-CHEESE",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Extra cheese",
          "price_delta": 150,
          "available": true,
          "position": 0,
          "updated_at": "2026-10-06T11:40:31.204Z"
        },
        {
          "object": "option",
          "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
          "external_id": "MOD-SALAMI",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Salami",
          "price_delta": 200,
          "available": false,
          "position": 1,
          "updated_at": "2026-10-06T11:40:31.204Z"
        }
      ],
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.option_group.updated

Un groupe d'options a changé de nom, de limites de sélection, de position ou de plat ; changed liste les champs, previous leurs anciennes valeurs. Les modifications de ses options arrivent sous forme de menu.option.*.

Droit requis: menu:read

Champs dans data

objectOptionGroup
The option group after this change. The fields in changed show the state of this event; a later change has its own event.
Champs contenus (10)
- objectstringobligatoire
  Always option_group.
  Valeurs:"option_group"
- idstring (uuid)obligatoire
  The option group id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this group; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it, e.g. Size, Extras.
  max 120 chars
- min_selectintegerobligatoire
  How many options the guest must pick at least (0 = optional).
  0 to 20
- max_selectintegerobligatoire
  How many options the guest may pick at most.
  1 to 20
- positionintegerobligatoire
  Sort order among groups.
- product_idstring (uuid)obligatoirepeut être null
  The product this group belongs to only; null for a shared group.
- optionsOption[]obligatoire
  Its options in order, including sold-out ones.
  Champs contenus (9)
  - objectstringobligatoire
    Always option.
    Valeurs:"option"
  - idstring (uuid)obligatoire
    The option id.
  - external_idstringobligatoirepeut être null
    Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
    1 to 100 chars
  - group_idstring (uuid)obligatoire
    The option group it belongs to.
  - namestringobligatoire
    Name as the guest sees it.
    max 120 chars
  - price_deltaintegerobligatoire
    Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
  - availablebooleanobligatoire
    false = sold out on every product that uses the group.
  - positionintegerobligatoire
    Sort order within the group.
  - updated_atstring (date-time)obligatoire
    Last change of one of its fields. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its own fields (not of its options). ISO 8601 in UTC (Z).
changedstring[]
The fields that changed: name, min_select, max_select, position, product_id.
Valeurs:"name""min_select""max_select""position""product_id"
previousobject
The earlier value of every field in changed (except tax_rates), and always nothing else.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option_group.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option_group",
      "id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "external_id": "GRP-EXTRAS",
      "name": "Extras",
      "min_select": 0,
      "max_select": 3,
      "position": 0,
      "product_id": null,
      "options": [
        {
          "object": "option",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "external_id": "MOD-CHEESE",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Extra cheese",
          "price_delta": 150,
          "available": true,
          "position": 0,
          "updated_at": "2026-10-06T11:40:31.204Z"
        },
        {
          "object": "option",
          "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
          "external_id": "MOD-SALAMI",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Salami",
          "price_delta": 200,
          "available": false,
          "position": 1,
          "updated_at": "2026-10-06T11:40:31.204Z"
        }
      ],
      "updated_at": "2026-10-06T11:40:31.204Z"
    },
    "changed": [
      "name"
    ],
    "previous": {}
  }
}

menu.option_group.deleted

Un groupe d'options a été supprimé, avec ses options : elles figurent dans object.options, sans menu.option.deleted distinct.

Droit requis: menu:read

Champs dans data

objectOptionGroup
The option group as it was right before it was deleted. Requests for its id answer 404 from now on.
Champs contenus (10)
- objectstringobligatoire
  Always option_group.
  Valeurs:"option_group"
- idstring (uuid)obligatoire
  The option group id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this group; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- namestringobligatoire
  Name as the guest sees it, e.g. Size, Extras.
  max 120 chars
- min_selectintegerobligatoire
  How many options the guest must pick at least (0 = optional).
  0 to 20
- max_selectintegerobligatoire
  How many options the guest may pick at most.
  1 to 20
- positionintegerobligatoire
  Sort order among groups.
- product_idstring (uuid)obligatoirepeut être null
  The product this group belongs to only; null for a shared group.
- optionsOption[]obligatoire
  Its options in order, including sold-out ones.
  Champs contenus (9)
  - objectstringobligatoire
    Always option.
    Valeurs:"option"
  - idstring (uuid)obligatoire
    The option id.
  - external_idstringobligatoirepeut être null
    Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
    1 to 100 chars
  - group_idstring (uuid)obligatoire
    The option group it belongs to.
  - namestringobligatoire
    Name as the guest sees it.
    max 120 chars
  - price_deltaintegerobligatoire
    Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
  - availablebooleanobligatoire
    false = sold out on every product that uses the group.
  - positionintegerobligatoire
    Sort order within the group.
  - updated_atstring (date-time)obligatoire
    Last change of one of its fields. ISO 8601 in UTC (Z).
- updated_atstring (date-time)obligatoire
  Last change of one of its own fields (not of its options). ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option_group.deleted",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option_group",
      "id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "external_id": "GRP-EXTRAS",
      "name": "Extras",
      "min_select": 0,
      "max_select": 3,
      "position": 0,
      "product_id": null,
      "options": [
        {
          "object": "option",
          "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
          "external_id": "MOD-CHEESE",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Extra cheese",
          "price_delta": 150,
          "available": true,
          "position": 0,
          "updated_at": "2026-10-06T11:40:31.204Z"
        },
        {
          "object": "option",
          "id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
          "external_id": "MOD-SALAMI",
          "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
          "name": "Salami",
          "price_delta": 200,
          "available": false,
          "position": 1,
          "updated_at": "2026-10-06T11:40:31.204Z"
        }
      ],
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.option.created

Une option (accompagnement, extra, taille) a été ajoutée à un groupe.

Droit requis: menu:read

Champs dans data

objectOption
The new option.
Champs contenus (9)
- objectstringobligatoire
  Always option.
  Valeurs:"option"
- idstring (uuid)obligatoire
  The option id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- group_idstring (uuid)obligatoire
  The option group it belongs to.
- namestringobligatoire
  Name as the guest sees it.
  max 120 chars
- price_deltaintegerobligatoire
  Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out on every product that uses the group.
- positionintegerobligatoire
  Sort order within the group.
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option.created",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "external_id": "MOD-CHEESE",
      "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "name": "Extra cheese",
      "price_delta": 150,
      "available": true,
      "position": 0,
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.option.updated

Une option a changé : épuisée, de retour, supplément, nom, position ou groupe. changed liste les champs, previous leurs anciennes valeurs et toujours available et price_delta.

Droit requis: menu:read

Champs dans data

objectOption
The option after this change. The fields in changed show the state of this event; a later change has its own event.
Champs contenus (9)
- objectstringobligatoire
  Always option.
  Valeurs:"option"
- idstring (uuid)obligatoire
  The option id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- group_idstring (uuid)obligatoire
  The option group it belongs to.
- namestringobligatoire
  Name as the guest sees it.
  max 120 chars
- price_deltaintegerobligatoire
  Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out on every product that uses the group.
- positionintegerobligatoire
  Sort order within the group.
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).
changedstring[]
The fields that changed: group_id, name, price_delta, available, position.
Valeurs:"group_id""name""price_delta""available""position"
previousobject
The earlier value of every field in changed (except tax_rates), and always available and price_delta (as before this change).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "external_id": "MOD-CHEESE",
      "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "name": "Extra cheese",
      "price_delta": 150,
      "available": true,
      "position": 0,
      "updated_at": "2026-10-06T11:40:31.204Z"
    },
    "changed": [
      "group_id"
    ],
    "previous": {}
  }
}

menu.option.deleted

Une option a été supprimée seule. object la montre telle qu'elle était avant. Les options supprimées avec leur groupe n'apparaissent que dans menu.option_group.deleted.

Droit requis: menu:read

Champs dans data

objectOption
The option as it was right before it was deleted. Requests for its id answer 404 from now on.
Champs contenus (9)
- objectstringobligatoire
  Always option.
  Valeurs:"option"
- idstring (uuid)obligatoire
  The option id.
- external_idstringobligatoirepeut être null
  Your app's external_id for this option; null if it has none. Always null in webhook events and in GET /events: the envelope is built once and sent the same to every receiver, but this value belongs to a single app. Retrieve the object to see yours.
  1 to 100 chars
- group_idstring (uuid)obligatoire
  The option group it belongs to.
- namestringobligatoire
  Name as the guest sees it.
  max 120 chars
- price_deltaintegerobligatoire
  Surcharge, may be negative. Integer amount in the smallest currency unit (cents).
- availablebooleanobligatoire
  false = sold out on every product that uses the group.
- positionintegerobligatoire
  Sort order within the group.
- updated_atstring (date-time)obligatoire
  Last change of one of its fields. ISO 8601 in UTC (Z).

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.option.deleted",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "option",
      "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "external_id": "MOD-CHEESE",
      "group_id": "5e4d3c2b-1a09-4f8e-b7d6-c5b4a3928170",
      "name": "Extra cheese",
      "price_delta": 150,
      "available": true,
      "position": 0,
      "updated_at": "2026-10-06T11:40:31.204Z"
    }
  }
}

menu.synced

Une synchronisation avec PUT /menu a modifié la carte. Envoyé à la place des événements menu.* individuels pour tout ce que la synchronisation a modifié : une synchronisation, un événement, avec mode, summary et connection_id, la connexion qui a synchronisé (votre propre synchronisation porte votre connexion). Récupérez ce qui a changé avec updated_since sur GET /menu/products et GET /menu/options.

Droit requis: menu:read

Champs dans data

modestringobligatoire
The mode of the sync.
Valeurs:"merge""replace"
summaryMenuSyncSummaryobligatoire
What the sync created, updated and deleted.
Champs contenus (4)
- categoriesMenuSyncCountsobligatoire
  Categories.
  Champs contenus (4)
  - createdintegerobligatoire
    Created by this sync.
  - updatedintegerobligatoire
    Changed by this sync.
  - unchangedintegerobligatoire
    Listed, but already as in the body.
  - deletedintegerobligatoire
    Deleted by this sync (replace only).
- productsMenuSyncCountsobligatoire
  Products.
  Champs contenus (4)
  - createdintegerobligatoire
    Created by this sync.
  - updatedintegerobligatoire
    Changed by this sync.
  - unchangedintegerobligatoire
    Listed, but already as in the body.
  - deletedintegerobligatoire
    Deleted by this sync (replace only).
- option_groupsMenuSyncCountsobligatoire
  Option groups.
  Champs contenus (4)
  - createdintegerobligatoire
    Created by this sync.
  - updatedintegerobligatoire
    Changed by this sync.
  - unchangedintegerobligatoire
    Listed, but already as in the body.
  - deletedintegerobligatoire
    Deleted by this sync (replace only).
- optionsMenuSyncCountsobligatoire
  Options.
  Champs contenus (4)
  - createdintegerobligatoire
    Created by this sync.
  - updatedintegerobligatoire
    Changed by this sync.
  - unchangedintegerobligatoire
    Listed, but already as in the body.
  - deletedintegerobligatoire
    Deleted by this sync (replace only).
connection_idstring (uuid)obligatoirepeut être null
The connection that ran the sync. Equal to the envelope's connection_id when it was your own app on this restaurant. null for syncs before 8 October 2026.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "menu.synced",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "mode": "merge",
    "summary": {
      "categories": {
        "created": 0,
        "updated": 0,
        "unchanged": 0,
        "deleted": 0
      },
      "products": {
        "created": 0,
        "updated": 0,
        "unchanged": 0,
        "deleted": 0
      },
      "option_groups": {
        "created": 0,
        "updated": 0,
        "unchanged": 0,
        "deleted": 0
      },
      "options": {
        "created": 0,
        "updated": 0,
        "unchanged": 0,
        "deleted": 0
      }
    },
    "connection_id": "c1c626ff-ee3d-46a3-a1c6-26ffee3d56a3"
  }
}

Établissement

store.paused

La prise de commandes a été mise en pause, jusqu'à paused_until ; object est l'établissement, comme dans store.updated. Quand la pause se termine d'elle-même, aucun événement distinct n'est envoyé.

Droit requis: store:read

Champs dans data

objectStoreobligatoire
The store when the event was first read. paused_until and note next to it are the values of this pause.
Champs contenus (22)
- objectstringobligatoire
  Always store.
  Valeurs:"store"
- idstring (uuid)obligatoire
  The restaurant.
- namestringobligatoire
  Name.
- slugstringobligatoire
  Its address: <slug>.flavoso.com.
- timezonestringobligatoire
  IANA time zone of all local times.
- currencystringobligatoire
  ISO 4217.
- statusstringobligatoire
  Right now: open, closed (outside hours or a closed special day), or paused.
  Valeurs:"open""closed""paused"
- paused_untilstring (date-time)obligatoirepeut être null
  End of the running pause; null without one.
- pause_notestringobligatoirepeut être null
  Reason of the running pause.
- next_opening_atstring (date-time)obligatoirepeut être null
  Next opening while closed (looks two weeks ahead); null while open.
- preordersbooleanobligatoire
  Guests may order for a later time, also while closed.
- order_typesobjectobligatoire
  Which order types guests can choose.
  Champs contenus (3)
  - pickupbooleanobligatoire
    Pickup.
  - deliverybooleanobligatoire
    Delivery.
  - dine_inbooleanobligatoire
    Ordering at the table via QR code (Pro and up).
- order_statusesstring[]obligatoire
  Statuses this restaurant uses, in order, plus completed and cancelled.
- lead_timesobjectobligatoire
  How long the kitchen needs; the earliest pickup or delivery time.
  Champs contenus (2)
  - pickup_minutesintegerobligatoire
    Minutes until pickup, 0 to 240.
  - delivery_minutesintegerobligatoire
    Minutes until delivery, 0 to 360.
- min_orderintegerobligatoire
  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).
- always_openbooleanobligatoire
  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.
- opening_hoursWeekWindow[]obligatoire
  The weekly opening windows; a weekday without windows is closed.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- delivery_hoursWeekWindow[]obligatoire
  Weekly delivery windows; empty means delivery follows opening_hours.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- closuresClosure[]obligatoire
  Upcoming special days (today and later).
  Champs contenus (5)
  - objectstringobligatoire
    Always closure.
    Valeurs:"closure"
  - datestring (date)obligatoire
    The day. A date YYYY-MM-DD in the restaurant's time zone.
  - closedbooleanobligatoire
    Closed all day.
  - hoursTimeWindow[]obligatoire
    The windows of that day when not closed (at most two).
    Champs contenus (2)
    openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    closestringobligatoire
    Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - notestringobligatoirepeut être null
    Note, e.g. the reason.
- contactobjectobligatoire
  Public contact details.
  Champs contenus (3)
  - phonestringobligatoirepeut être null
    Phone.
  - emailstringobligatoirepeut être null
    E-mail.
  - websitestringobligatoirepeut être null
    Website.
- addressobjectobligatoirepeut être null
  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.
  Champs contenus (4)
  - linestringobligatoirepeut être null
    Street and number (or the whole address when it cannot be split).
  - postal_codestringobligatoirepeut être null
    Postal code, when it can be read from the address.
  - citystringobligatoirepeut être null
    City, when it can be read from the address.
  - countrystringobligatoirepeut être null
    ISO 3166-1 alpha-2, as in GET /me.
- locationobjectobligatoirepeut être null
  Coordinates; null when not set.
  Champs contenus (2)
  - latnumberobligatoire
    Latitude.
  - lonnumberobligatoire
    Longitude.
paused_untilstring (date-time)obligatoire
When ordering resumes by itself.
notestringobligatoirepeut être null
The reason, if given.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "store.paused",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "store",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "name": "string",
      "slug": "pizzeria-example",
      "timezone": "Europe/Berlin",
      "currency": "EUR",
      "status": "open",
      "paused_until": "2026-10-04T17:44:59.942Z",
      "pause_note": "string",
      "next_opening_at": "2026-10-04T17:44:59.942Z",
      "preorders": true,
      "order_types": {
        "pickup": true,
        "delivery": true,
        "dine_in": true
      },
      "order_statuses": [
        "string"
      ],
      "lead_times": {
        "pickup_minutes": 30,
        "delivery_minutes": 30
      },
      "min_order": 1290,
      "always_open": true,
      "opening_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "delivery_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "closures": [
        {
          "object": "closure",
          "date": "2026-10-04",
          "closed": true,
          "hours": [
            {
              "open": "11:30",
              "close": "22:00"
            }
          ],
          "note": "string"
        }
      ],
      "contact": {
        "phone": "string",
        "email": "string",
        "website": "string"
      },
      "address": {
        "line": "string",
        "postal_code": "string",
        "city": "string",
        "country": "DE"
      },
      "location": {
        "lat": 0,
        "lon": 0
      }
    },
    "paused_until": "2026-10-04T17:44:59.942Z",
    "note": "string"
  }
}

store.resumed

Une pause en cours a été levée avant son terme ; object est l'établissement.

Droit requis: store:read

Champs dans data

objectStoreobligatoire
The store when the event was first read.
Champs contenus (22)
- objectstringobligatoire
  Always store.
  Valeurs:"store"
- idstring (uuid)obligatoire
  The restaurant.
- namestringobligatoire
  Name.
- slugstringobligatoire
  Its address: <slug>.flavoso.com.
- timezonestringobligatoire
  IANA time zone of all local times.
- currencystringobligatoire
  ISO 4217.
- statusstringobligatoire
  Right now: open, closed (outside hours or a closed special day), or paused.
  Valeurs:"open""closed""paused"
- paused_untilstring (date-time)obligatoirepeut être null
  End of the running pause; null without one.
- pause_notestringobligatoirepeut être null
  Reason of the running pause.
- next_opening_atstring (date-time)obligatoirepeut être null
  Next opening while closed (looks two weeks ahead); null while open.
- preordersbooleanobligatoire
  Guests may order for a later time, also while closed.
- order_typesobjectobligatoire
  Which order types guests can choose.
  Champs contenus (3)
  - pickupbooleanobligatoire
    Pickup.
  - deliverybooleanobligatoire
    Delivery.
  - dine_inbooleanobligatoire
    Ordering at the table via QR code (Pro and up).
- order_statusesstring[]obligatoire
  Statuses this restaurant uses, in order, plus completed and cancelled.
- lead_timesobjectobligatoire
  How long the kitchen needs; the earliest pickup or delivery time.
  Champs contenus (2)
  - pickup_minutesintegerobligatoire
    Minutes until pickup, 0 to 240.
  - delivery_minutesintegerobligatoire
    Minutes until delivery, 0 to 360.
- min_orderintegerobligatoire
  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).
- always_openbooleanobligatoire
  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.
- opening_hoursWeekWindow[]obligatoire
  The weekly opening windows; a weekday without windows is closed.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- delivery_hoursWeekWindow[]obligatoire
  Weekly delivery windows; empty means delivery follows opening_hours.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- closuresClosure[]obligatoire
  Upcoming special days (today and later).
  Champs contenus (5)
  - objectstringobligatoire
    Always closure.
    Valeurs:"closure"
  - datestring (date)obligatoire
    The day. A date YYYY-MM-DD in the restaurant's time zone.
  - closedbooleanobligatoire
    Closed all day.
  - hoursTimeWindow[]obligatoire
    The windows of that day when not closed (at most two).
    Champs contenus (2)
    openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    closestringobligatoire
    Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - notestringobligatoirepeut être null
    Note, e.g. the reason.
- contactobjectobligatoire
  Public contact details.
  Champs contenus (3)
  - phonestringobligatoirepeut être null
    Phone.
  - emailstringobligatoirepeut être null
    E-mail.
  - websitestringobligatoirepeut être null
    Website.
- addressobjectobligatoirepeut être null
  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.
  Champs contenus (4)
  - linestringobligatoirepeut être null
    Street and number (or the whole address when it cannot be split).
  - postal_codestringobligatoirepeut être null
    Postal code, when it can be read from the address.
  - citystringobligatoirepeut être null
    City, when it can be read from the address.
  - countrystringobligatoirepeut être null
    ISO 3166-1 alpha-2, as in GET /me.
- locationobjectobligatoirepeut être null
  Coordinates; null when not set.
  Champs contenus (2)
  - latnumberobligatoire
    Latitude.
  - lonnumberobligatoire
    Longitude.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "store.resumed",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "store",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "name": "string",
      "slug": "pizzeria-example",
      "timezone": "Europe/Berlin",
      "currency": "EUR",
      "status": "open",
      "paused_until": "2026-10-04T17:44:59.942Z",
      "pause_note": "string",
      "next_opening_at": "2026-10-04T17:44:59.942Z",
      "preorders": true,
      "order_types": {
        "pickup": true,
        "delivery": true,
        "dine_in": true
      },
      "order_statuses": [
        "string"
      ],
      "lead_times": {
        "pickup_minutes": 30,
        "delivery_minutes": 30
      },
      "min_order": 1290,
      "always_open": true,
      "opening_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "delivery_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "closures": [
        {
          "object": "closure",
          "date": "2026-10-04",
          "closed": true,
          "hours": [
            {
              "open": "11:30",
              "close": "22:00"
            }
          ],
          "note": "string"
        }
      ],
      "contact": {
        "phone": "string",
        "email": "string",
        "website": "string"
      },
      "address": {
        "line": "string",
        "postal_code": "string",
        "city": "string",
        "country": "DE"
      },
      "location": {
        "lat": 0,
        "lon": 0
      }
    }
  }
}

store.updated

Les horaires d'ouverture, les jours particuliers, les délais de préparation, les modes de commande, le minimum de commande ou les statuts utilisés par l'établissement (order_statuses) ont changé ; changed indique lesquels.

Droit requis: store:read

Champs dans data

objectStoreobligatoire
The restaurant as a store: status, schedule, ordering rules and contact.
Champs contenus (22)
- objectstringobligatoire
  Always store.
  Valeurs:"store"
- idstring (uuid)obligatoire
  The restaurant.
- namestringobligatoire
  Name.
- slugstringobligatoire
  Its address: <slug>.flavoso.com.
- timezonestringobligatoire
  IANA time zone of all local times.
- currencystringobligatoire
  ISO 4217.
- statusstringobligatoire
  Right now: open, closed (outside hours or a closed special day), or paused.
  Valeurs:"open""closed""paused"
- paused_untilstring (date-time)obligatoirepeut être null
  End of the running pause; null without one.
- pause_notestringobligatoirepeut être null
  Reason of the running pause.
- next_opening_atstring (date-time)obligatoirepeut être null
  Next opening while closed (looks two weeks ahead); null while open.
- preordersbooleanobligatoire
  Guests may order for a later time, also while closed.
- order_typesobjectobligatoire
  Which order types guests can choose.
  Champs contenus (3)
  - pickupbooleanobligatoire
    Pickup.
  - deliverybooleanobligatoire
    Delivery.
  - dine_inbooleanobligatoire
    Ordering at the table via QR code (Pro and up).
- order_statusesstring[]obligatoire
  Statuses this restaurant uses, in order, plus completed and cancelled.
- lead_timesobjectobligatoire
  How long the kitchen needs; the earliest pickup or delivery time.
  Champs contenus (2)
  - pickup_minutesintegerobligatoire
    Minutes until pickup, 0 to 240.
  - delivery_minutesintegerobligatoire
    Minutes until delivery, 0 to 360.
- min_orderintegerobligatoire
  Minimum order value for delivery (0 = none). Integer amount in the smallest currency unit (cents).
- always_openbooleanobligatoire
  No weekly schedule is set: online orders are taken around the clock (special days and pauses still apply) and no reservation times are offered.
- opening_hoursWeekWindow[]obligatoire
  The weekly opening windows; a weekday without windows is closed.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- delivery_hoursWeekWindow[]obligatoire
  Weekly delivery windows; empty means delivery follows opening_hours.
  Champs contenus (3)
  - weekdayintegerobligatoire
    0 = Monday … 6 = Sunday.
    0 to 6
  - openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - closestringobligatoire
    Closing. Earlier than open: the window runs past midnight. Equal to open: until midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
- closuresClosure[]obligatoire
  Upcoming special days (today and later).
  Champs contenus (5)
  - objectstringobligatoire
    Always closure.
    Valeurs:"closure"
  - datestring (date)obligatoire
    The day. A date YYYY-MM-DD in the restaurant's time zone.
  - closedbooleanobligatoire
    Closed all day.
  - hoursTimeWindow[]obligatoire
    The windows of that day when not closed (at most two).
    Champs contenus (2)
    openstringobligatoire
    Opening. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    closestringobligatoire
    Closing; earlier than open runs past midnight. 24-hour local time "HH:MM" in the restaurant's time zone.
    pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
  - notestringobligatoirepeut être null
    Note, e.g. the reason.
- contactobjectobligatoire
  Public contact details.
  Champs contenus (3)
  - phonestringobligatoirepeut être null
    Phone.
  - emailstringobligatoirepeut être null
    E-mail.
  - websitestringobligatoirepeut être null
    Website.
- addressobjectobligatoirepeut être null
  The address as far as it is known. Restaurants type it freely; postal code and city are only split out when a line starts with a postal code.
  Champs contenus (4)
  - linestringobligatoirepeut être null
    Street and number (or the whole address when it cannot be split).
  - postal_codestringobligatoirepeut être null
    Postal code, when it can be read from the address.
  - citystringobligatoirepeut être null
    City, when it can be read from the address.
  - countrystringobligatoirepeut être null
    ISO 3166-1 alpha-2, as in GET /me.
- locationobjectobligatoirepeut être null
  Coordinates; null when not set.
  Champs contenus (2)
  - latnumberobligatoire
    Latitude.
  - lonnumberobligatoire
    Longitude.
changedstring[]obligatoire
The Store fields this change touched.
Valeurs:"opening_hours""delivery_hours""closures""lead_times""preorders""order_types""min_order""order_statuses"

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "store.updated",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "store",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "name": "string",
      "slug": "pizzeria-example",
      "timezone": "Europe/Berlin",
      "currency": "EUR",
      "status": "open",
      "paused_until": "2026-10-04T17:44:59.942Z",
      "pause_note": "string",
      "next_opening_at": "2026-10-04T17:44:59.942Z",
      "preorders": true,
      "order_types": {
        "pickup": true,
        "delivery": true,
        "dine_in": true
      },
      "order_statuses": [
        "string"
      ],
      "lead_times": {
        "pickup_minutes": 30,
        "delivery_minutes": 30
      },
      "min_order": 1290,
      "always_open": true,
      "opening_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "delivery_hours": [
        {
          "weekday": 0,
          "open": "11:30",
          "close": "22:00"
        }
      ],
      "closures": [
        {
          "object": "closure",
          "date": "2026-10-04",
          "closed": true,
          "hours": [
            {
              "open": "11:30",
              "close": "22:00"
            }
          ],
          "note": "string"
        }
      ],
      "contact": {
        "phone": "string",
        "email": "string",
        "website": "string"
      },
      "address": {
        "line": "string",
        "postal_code": "string",
        "city": "string",
        "country": "DE"
      },
      "location": {
        "lat": 0,
        "lon": 0
      }
    },
    "changed": [
      "opening_hours"
    ]
  }
}

Connexion

app.connected

Un établissement a connecté votre application, ou l'a connectée à nouveau après la fin de la connexion.

Droit requis: aucun, seulement la connexion elle-même

Champs dans data

objectConnectionSummaryobligatoire
The connection in app.* events.
Champs contenus (5)
- objectstringobligatoire
  Always connection.
  Valeurs:"connection"
- idstring (uuid)obligatoire
  The connection.
- scopesstring[]obligatoire
  The permissions the restaurant granted.
  Valeurs:"orders:read""orders:write""menu:read""menu:write""store:read""store:write""reservations:read""reservations:write""reports:read"
- created_atstring (date-time)obligatoire
  When the restaurant connected the app. ISO 8601 in UTC (Z).
- revoked_atstring (date-time)obligatoirepeut être null
  When the connection ended; null while it is active.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "app.connected",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "connection",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "scopes": [
        "orders:read"
      ],
      "created_at": "2026-10-04T17:44:59.942Z",
      "revoked_at": "2026-10-04T17:44:59.942Z"
    }
  }
}

app.scopes_changed

Les droits d'une connexion existante ont changé, parce que le propriétaire a connecté à nouveau votre application avec d'autres droits. previous_scopes contient les anciens.

Droit requis: aucun, seulement la connexion elle-même

Champs dans data

objectConnectionSummaryobligatoire
The connection in app.* events.
Champs contenus (5)
- objectstringobligatoire
  Always connection.
  Valeurs:"connection"
- idstring (uuid)obligatoire
  The connection.
- scopesstring[]obligatoire
  The permissions the restaurant granted.
  Valeurs:"orders:read""orders:write""menu:read""menu:write""store:read""store:write""reservations:read""reservations:write""reports:read"
- created_atstring (date-time)obligatoire
  When the restaurant connected the app. ISO 8601 in UTC (Z).
- revoked_atstring (date-time)obligatoirepeut être null
  When the connection ended; null while it is active.
previous_scopesstring[]obligatoire
The permissions before this change.

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "app.scopes_changed",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "connection",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "scopes": [
        "orders:read"
      ],
      "created_at": "2026-10-04T17:44:59.942Z",
      "revoked_at": "2026-10-04T17:44:59.942Z"
    },
    "previous_scopes": [
      "string"
    ]
  }
}

app.disconnected

La connexion à un établissement a pris fin : le propriétaire a déconnecté l'application, votre application s'est déconnectée (DELETE /connection) ou Flavoso y a mis fin. reason indique qui. Ensuite, plus aucun jeton de cette connexion ne fonctionne ; c'est pourquoi il n'arrive jamais via GET /events.

Droit requis: aucun, seulement la connexion elle-même

Champs dans data

objectConnectionSummaryobligatoire
The connection in app.* events.
Champs contenus (5)
- objectstringobligatoire
  Always connection.
  Valeurs:"connection"
- idstring (uuid)obligatoire
  The connection.
- scopesstring[]obligatoire
  The permissions the restaurant granted.
  Valeurs:"orders:read""orders:write""menu:read""menu:write""store:read""store:write""reservations:read""reservations:write""reports:read"
- created_atstring (date-time)obligatoire
  When the restaurant connected the app. ISO 8601 in UTC (Z).
- revoked_atstring (date-time)obligatoirepeut être null
  When the connection ended; null while it is active.
reasonstringobligatoire
Who ended the connection.
Valeurs:"owner""app""admin"

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "app.disconnected",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "object": {
      "object": "connection",
      "id": "37386ae0-ca76-4d50-a738-6ae0ca766d50",
      "scopes": [
        "orders:read"
      ],
      "created_at": "2026-10-04T17:44:59.942Z",
      "revoked_at": "2026-10-04T17:44:59.942Z"
    },
    "reason": "owner"
  }
}

Test

ping

Uniquement via « Envoyer un événement de test » dans la console. N'est jamais créé de lui-même.

Droit requis: aucun, seulement la connexion elle-même

Champs dans data

messagestring

Exemple

{
  "id": "evt_2bf5a9b06b75442a9244e884a1acfc57",
  "object": "event",
  "type": "ping",
  "created_at": "2026-10-04T17:46:12.410Z",
  "api_version": "2026-10-08",
  "livemode": true,
  "tenant_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "connection_id": "4b3f7c1e-9a2d-4e8b-b5f6-0c1d2e3f4a5b",
  "data": {
    "message": "string"
  }
}

Une question reste ouverte ? Écrivez à support@flavoso.com en indiquant l'identifiant de X-Request-Id. Il nous permet de retrouver votre requête dans le journal.