Skip to main content
A menu in Fire is a full catalog definition for a specific store and channel combination — categories, products, modifier groups, and schedules. Every time a menu changes, Fire emits a menu.updated event with the complete catalog ready to be forwarded downstream. The payload is self-contained. You don’t need to call additional endpoints to get the menu data — everything is included.

​
Processing

1

Verify the signature

Extract the X-Fire-Signature header and validate it against the raw request body using your integration’s signing secret. The secret is generated when you register the endpoint in the Fire dashboard under Aggregator integrations. See Authentication for the full verification process.
2

Acknowledge immediately

Return 200 OK before doing any processing. Fire will retry if it doesn’t receive a response in time.
3

Identify the menu

Use data.menu.list.storeId and data.menu.list.channelId to determine which store and channel this menu belongs to.
4

Replace the full menu

Apply data.menu as a complete replacement in your downstream system. This is not a diff — overwrite the previous state entirely.
The payload is a complete menu, not a diff. Replace the entire menu in the downstream system every time you receive this event.

​
Payload

{
  "event": {
    "id": "evt_def456",
    "type": "menu.updated",
    "executionId": "exec_abc123",
    "createdAt": "2025-01-15T14:31:00.000Z"
  },
  "data": {
    "account": "1",
    "country": "BR",
    "groupId": "a3f7c2d1-84be-4e10-9b3a-2c5d6e7f8091",
    "menu": {
      "list": {
        "listId": "805-iFood-delivery",
        "listName": "iFood - Store 805",
        "storeId": "805",
        "channelId": "0E049503-85CF-E511-80C6-000D3A3261F3",
        "channelReferenceName": "iFood",
        "schedules": [ ... ]
      },
      "categories": [ ... ],
      "products": [ ... ],
      "modifierGroups": [ ... ]
    }
  }
}
See menu.updated for the full schema with all fields and types.

​
data.menu.list

Identifies which store and channel the menu belongs to. Use storeId and channelId as the key to upsert in your downstream system. The schedules field on list defines the time windows when the menu is active. Always present; null if no schedule is defined.

​
data.menu.categories

List of visible categories. Each category includes productListing — an array with the productId of its products and their display positions. Categories can also have their own schedules that restrict their visibility to certain hours, independently of the menu schedule.

​
data.menu.products

A flat list of all items in the menu — both top-level products and options used in modifier groups. The type field indicates each item’s role:
TypeDescription
PRODUCTSellable top-level item
MODIFIERModifier option (e.g. size, extra ingredient)
COMPLEMENTComplement included in a selection
COMBOProduct whose price depends on the customer’s selections
For COMBO products, priceInfo.price is always 0. Use priceInfo.referencePrice as the header price. Modifier groups on a combo may include per-option price overrides. See the Products structure guide for full handling of COMBOs and modifier overrides.

​
data.menu.modifierGroups

Defines option groups and their selection rules. Each group references its options via productId, which must exist in products.
FieldDescription
minOptionsMinimum selections required (0 = optional group)
maxOptionsMaximum selections allowed
typeRADIO (single choice) or CHECKBOX (multiple)

​
groupId

Events emitted in the same publication run share the same groupId. You can use it to correlate related events, but it is not required for processing — each event is independent and self-contained.

​
Removing a menu

Fire does not emit a separate delete event. To signal the removal of a menu, Fire sends a menu.updated with categories, products, and modifierGroups as empty arrays. Treat an empty menu as a signal to deactivate or remove it in your downstream system.

​
Idempotency

You may receive the same event more than once due to retries. Since each payload is a complete replacement, applying it twice produces the same result.