KDS Order Created Webhook Event

Overview

This event fires when a new KDS order is created. If an order is sent to multiple screens this event will only fire once.

Body Parameters

Property	Type	Description
triggeredAction	string	value: `KDS Order Created`
brand	Brand	brand order belongs to
location	Location	location order belongs to
data	Data	order information

Brand

Property	Type	Description
id	string	uuid of brand
name	string	name of brand

Location

Property	Type	Description
id	string	uuid of location
name	string	name of location
number	string	user-entered location number

Data

Property	Type	Description
id	string	uuid of the order record
source	string	order source; `internal` if the order came from a point of sale integration
name	string	order name/number generated by point of sale automatically or through user input
type	string	order type; possible values `forhere`, `togo`, `pickup`, `curbside`, `delivery`, `drivethru`
terminal	string	point of sale terminal generating order; can be null
items	Items	array of menu items on the order
locationId	string	order’s location id
orderId	string	order id generated using a hash of order data
createdOn	timestamp	timestamp of when order record was created in UTC
supplierOrderId	string	integrator provided order id; if none is provided this equals `orderId`

Item

Note: Order level special instructions are added as an item where the name is “Special Instructions” and the modifier name is the instruction. Item level special instructions are added as modifiers to the item they are for.

Property	Type	Description
itemId	string	uuid of the menu item in Fresh system; can be null
quantity	integer	quantity of menu item on order
name	string	name of menu item
menuItemId	string	id of the menu item in integrator’s system; can be null
categoryIds	string	id of the menu item’s category; can be null
modifiers	Modifiers	array of modifiers for the item

Modifier

Property	Type	Description
id	string	uuid of the modifier in Fresh system; can be null
name	string	name of the modifier

Example

{
	"triggeredAction": "KDS Order Created",
	"brand": {
		"id": "10b4039e-01d2-4399-9d93-52b850fc5751",
		"name": "KDS Test Brand"
	},
	"location": {
		"id": "6c4e879e-3ab5-4e5a-be1d-cf48fe809559",
		"name": "Atlanta",
		"number": "4"
	},
	"data": {
		"id": "b4d64698-4eec-4ba5-99ac-71ac4ed432cf",
		"source": "internal",
		"name": "Jennifer FOR HERE",
		"type": "forhere",
		"terminal": "PosTerminal",
		"items": [{
			"itemId": null,
			"quantity": 1,
			"name": "Iced Coffee",
			"menuItemId": null,
			"categoryIds": null,
			"components": [],
			"modifiers": [{
				"id": null,
				"name": "Cream",
				"components": null
			}, {
				"id": null,
				"name": "Caramel",
				"components": null
			}, {
				"id": null,
				"name": "Simple Syrup",
				"components": null
			}, {
				"id": null,
				"name": "- Extra ice",
				"components": null
			}]
		}],
		"locationId": "6c4e879e-3ab5-4e5a-be1d-cf48fe809559",
		"orderId": "01ff6df10f74761b59090cf7fbbd2225f34615cf",
		"createdOn": "2023-04-11T18:41:22.789Z",
		"supplierOrderId": "01ff6df10f74761b59090cf7fbbd2225f34615cf"
	}
}