This webhook endpoint facilitates real-time menu updates and supports critical workflows, including:
- Menu Update Request by Integration Partner: Sends the complete menu to the integration partner upon request.
- Menu Notification Triggered by POS System: Notifies the integration partner to fetch the latest menu, ensuring their platform reflects updated information.
In both cases, the entire menu is shared via the webhook for synchronization
Integration Partner Webhook Requirements
Integration partners are encouraged to implement this webhook to enable real-time menu update.
1. Webhook Specification
- Endpoint: HTTPs
- RequestType: POST
- RequestBody: Please see below sample request body
2. Webhook Request
Khumbu will send following request object to Menu Update webhook endpoint. For more detailed request parameters, please follow this Menu Update Webhook
Request Body
{
"providerName": "standardprovider",
"partnerName": "simphony",
"marketName": "plkpl",
"storeInformation": {
"providerStoreId": "999999",
"partnerStoreId": "12345",
"additionalProperties": {
"REVENUE_CENTER_ID": "11",
"ORDER_TYPE_ID": "2",
"TENDER_MEDIA_ID": "901",
"TIME_ZONE": "America/New_York"
}
},
"menus": [
{
"id": "opn:p300460:11",
"name": "Simphony Menu",
"categories": [
{
"categoryId": "101",
"name": "Sides",
"items": [
{
"itemId": "101000000",
"name": "***SIDES***",
"itemVariations": [
{
"itemVariationId": "101000000||1||1",
"name": "SIDES",
"price": 100,
"inStock": true,
"optionGroups": [
{
"optionGroupId": "255",
"name": "GENERAL FOOD MODS",
"minQuantity": 0,
"maxQuantity": 0,
"options": [
{
"optionId": "199000002||1||1",
"name": "NO",
"price": 0,
"inStock": true
},
{
"optionId": "199000005||1||1",
"name": "ON SIDE",
"price": 0,
"inStock": true
}
]
}
]
}
]
},
{
"itemId": "101000001",
"name": "French Fries",
"itemVariations": [
{
"itemVariationId": "101000001||2||1",
"name": "French Fries..",
"price": 60,
"inStock": true,
"optionGroups": [
{
"optionGroupId": "30",
"name": "DRESSING",
"minQuantity": 0,
"maxQuantity": 0,
"options": [
{
"optionId": "199006001||1||1",
"name": "BBQ",
"price": 200,
"inStock": true
},
{
"optionId": "199006002||1||1",
"name": "Ranch",
"price": 0,
"inStock": true
}
]
}
]
}
]
}
]
},
{
"categoryId": "400",
"name": "\"***WINE***\"",
"items": []
}
],
"combos": [
{
"comboId": "1001",
"name": "Chicken Burger Meal",
"inStock": true,
"comboGroups": [
{
"comboGroupId": "1001",
"name": "Chicken Burger",
"minQuantity": 1,
"maxQuantity": 1,
"items": [
{
"itemId": "131000001",
"name": "Chicken Burger",
"itemVariations": [
{
"itemVariationId": "131000001||0||1",
"name": "Chicken Burger",
"price": 0,
"inStock": true,
"optionGroups": [
{
"optionGroupId": "253",
"name": "PREFIX",
"minQuantity": 0,
"maxQuantity": 0,
"options": [
{
"optionId": "199008001||1||1",
"name": "White Bun",
"price": 0,
"inStock": true
},
{
"optionId": "199008002||1||1",
"name": "WW Bun",
"price": 0,
"inStock": true
}
]
}
]
}
]
},
{
"itemId": "132000002",
"name": "MED Fries",
"itemVariations": [
{
"itemVariationId": "132000002||0||1",
"name": "MED Fries",
"price": 50,
"inStock": true,
"optionGroups": [
{
"optionGroupId": "255",
"name": "GENERAL FOOD MODS",
"minQuantity": 0,
"maxQuantity": 0,
"options": [
{
"optionId": "199001004||1||1",
"name": "Medium",
"price": 0,
"inStock": true
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}3. Webhook Response
Response Body
HTTP code :
- Success (HTTP code - 200)
- Failure ( any other HTTP code, along with error message)