menu.changed webhook
The menu.changed webhook: one of the restaurant's menus, its prices, its dishes or your product ids changed. Read the menu again from your backend.
One of the restaurant's menus changed: read it again with Read a menu from your backend. Sent for every published menu, whatever the change came from (the dashboard, an import, your own calls), to your live and test endpoints alike, a few seconds after the change. reason says what moved:
reason | What moved | version |
|---|---|---|
content | What diners see: a price, a dish, a size, a choice, a category, a sold-out switch, the menu itself | The new version |
external_ids | Your ids for its dishes, sizes or options | Unchanged |
back_on_sale | A dish sold out until a time is on sale again because that time passed | Unchanged |
dishIdslists the dishes added, removed or changed when Tamr can tell. It is empty when only the menu itself changed, and absent when Tamr can't tell or more than 500 changed: read the whole menu.published: falsemeans the menu was taken offline: drop your copy. A deleted menu sends nothing, so also check from time to time that the menus you keep still answer.- Writing the same ids again sends nothing, so a backend that writes its ids back after reading the menu doesn't loop.
- Ids only: never a dish's name or the menu's.
The data object
| Field | Type | Description |
|---|---|---|
menuId | string | 1 to 200 characters. |
menuSlug | string | 1 to 200 characters. |
published | boolean | |
modes | array of string | At most 3 items. Each: One of dine_in, pickup, delivery. |
branches | array of object | At most 500 items. |
branches[].branchId | string | 1 to 200 characters. |
branches[].branch | string | An address: lower-case letters, digits and dashes. |
version | integer | 0 to 9,007,199,254,740,991. |
reason | string | One of content, external_ids, back_on_sale, other. An open list: read a value you don't know as other. |
changedAt | string (date-time) | |
dishIds | array of string | May be absent. At most 500 items. 1 to 200 characters. |
Examples
{
"type": "menu.changed",
"timestamp": "2026-11-16T09:30:04.000Z",
"livemode": true,
"data": {
"menuId": "cmmenu0001",
"menuSlug": "dinner",
"published": true,
"modes": [
"dine_in",
"pickup",
"delivery"
],
"branches": [
{
"branchId": "cmbranch01",
"branch": "achrafieh"
},
{
"branchId": "cmbranch02",
"branch": "hamra"
}
],
"version": 42,
"reason": "content",
"changedAt": "2026-11-16T09:30:04.000Z",
"dishIds": [
"cmdish0001",
"cmdish0002"
]
}
}Your ids changed: the version stays, read the menu again.
{
"type": "menu.changed",
"timestamp": "2026-11-16T10:00:00.000Z",
"livemode": false,
"data": {
"menuId": "cmmenu0001",
"menuSlug": "dinner",
"published": true,
"modes": [
"dine_in"
],
"branches": [
{
"branchId": "cmbranch01",
"branch": "achrafieh"
}
],
"version": 42,
"reason": "external_ids",
"changedAt": "2026-11-16T10:00:00.000Z",
"dishIds": [
"cmdish0001"
]
}
}The menu was unpublished, and Tamr can't tell which dishes changed.
{
"type": "menu.changed",
"timestamp": "2026-11-16T11:00:00.000Z",
"livemode": true,
"data": {
"menuId": "cmmenu0002",
"menuSlug": "delivery",
"published": false,
"modes": [
"delivery"
],
"branches": [],
"version": 7,
"reason": "content",
"changedAt": "2026-11-16T11:00:00.000Z"
}
}A reason from a newer server reads as other.
{
"type": "menu.changed",
"timestamp": "2026-11-16T12:00:00.000Z",
"livemode": true,
"data": {
"menuId": "cmmenu0001",
"menuSlug": "dinner",
"published": true,
"modes": [
"dine_in"
],
"branches": [],
"version": 43,
"reason": "seasonal_rotation",
"changedAt": "2026-11-16T12:00:00.000Z",
"dishIds": []
}
}A test event
What Send a test event in the dashboard sends: livemode: false, and every id starting test_.
{
"type": "menu.changed",
"timestamp": "2026-11-16T12:00:00.000Z",
"livemode": false,
"data": {
"menuId": "test_menu",
"menuSlug": "test-menu",
"published": true,
"modes": [
"dine_in"
],
"branches": [
{
"branchId": "test_branch",
"branch": "test-branch"
}
],
"version": 1,
"reason": "content",
"changedAt": "2026-11-16T12:00:00.000Z",
"dishIds": [
"test_dish"
]
}
}