Example Webhook Notifications
Introduction
Below are examples of notifications that will be sent to the configured webhook URL for a reservation integration.
Examples
- Order Open
- Order Update
- Order Close
{
"notificationType": "OPEN",
"account": {
"id": "1560383093473282",
"businessLocationId": "41910290874370",
"name": "Floor Plan 1, Table 1",
"accountNumber": "A90826.1",
"currencyCode": "GBP",
"staffId": "197180",
"staffName": "Reservation_System",
"openDate": 1712245742020,
"closeDate": null,
"paidAmount": 0,
"totalAmount": 0,
"coverCount": 4,
"gratuityAmount": 0,
"receiptNumber": null,
"accountObjectId": "41910290874562",
"taxAmount": 0,
"preTaxAmount": 0,
"serviceCharge": 0,
"tableName": "Table 1",
"accountProfileCode": "Reservation",
"accountProfileName": "Reservation",
"accountProfileId": "41910290874559",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1712245742274,
"offset": -240,
"totalDiscount": 0,
"transactionLines": [],
"paymentLines": [],
"discounts": [],
"externalReferences": [
{
"prefix": "TASK",
"reference": "RN-41910290874370-myApp#224"
}
],
"consumerRecord": {
"id": "131001",
"consumerRecordUUID": "309f2a5b-d42e-409e-aad3-1ce92719ce9c",
"consumer": null,
"contactInformation": {
"firstName": "John",
"lastName": "Purple",
"companyName": "",
"city": "",
"taxIdentifier": "",
"emailReceipts": true,
"fullName": "John Purple"
},
"externalReferences": [
{
"key": "myApp",
"reference": "OO.2439.ABC-18"
}
]
},
"currentProductionPhase": 0
},
"businessLocationId": 41910290874370,
"platformRestaurantId": "myApp-restaurant",
"sequenceId": "B90826.8",
"platformReservationId": "224"
}
{
"notificationType": "UPDATE",
"account": {
"id": "1560383093473282",
"businessLocationId": "41910290874370",
"name": "Floor Plan 1, Table 1",
"accountNumber": "A90826.1",
"currencyCode": "GBP",
"staffId": "4491",
"staffName": "Manager",
"openDate": 1712245742020,
"closeDate": null,
"paidAmount": 0,
"totalAmount": 10,
"coverCount": 4,
"gratuityAmount": 0,
"receiptNumber": null,
"accountObjectId": "41910290874562",
"taxAmount": 1.67,
"preTaxAmount": 8.33,
"serviceCharge": 0,
"tableName": "Table 1",
"accountProfileCode": "Reservation",
"accountProfileName": "Reservation",
"accountProfileId": "41910290874559",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1712245742274,
"offset": -240,
"totalDiscount": 0,
"transactionLines": [
{
"id": "1560383093473286",
"accountId": "1560383093473282",
"amount": 10,
"unitAmount": 10,
"quantity": 1,
"nameOverride": "",
"itemDescription": "Burger",
"accountingGroupId": "41910290874411",
"accountingGroupName": "Food",
"itemId": "41910290874538",
"itemSku": "13",
"date": 1712246167871,
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10,
"amountLessTax": 8.33,
"discountedAmount": 0,
"grossUnitAmount": 10,
"activeTax": {
"code": "VAT20",
"description": "VAT 20%",
"rate": 1.2,
"taxIncluded": true
},
"subLines": [],
"modifiers": []
}
],
"paymentLines": [],
"discounts": [],
"externalReferences": [
{
"prefix": "TASK",
"reference": "RN-41910290874370-myApp#224"
}
],
"consumerRecord": {
"id": "131001",
"consumerRecordUUID": "309f2a5b-d42e-409e-aad3-1ce92719ce9c",
"consumer": null,
"contactInformation": {
"firstName": "John",
"lastName": "Purple",
"companyName": "",
"city": "",
"taxIdentifier": "",
"emailReceipts": true,
"fullName": "John Purple"
},
"externalReferences": [
{
"key": "myApp",
"reference": "OO.2439.ABC-18"
}
]
},
"currentProductionPhase": 0
},
"businessLocationId": 41910290874370,
"platformRestaurantId": "myApp-restaurant",
"sequenceId": "B90826.17",
"platformReservationId": "224"
}
{
"notificationType": "CLOSE",
"account": {
"id": "1560383093473282",
"businessLocationId": "41910290874370",
"name": "Floor Plan 1, Table 1",
"accountNumber": "A90826.1",
"currencyCode": "GBP",
"staffId": "4491",
"staffName": "Manager",
"openDate": 1712245742020,
"closeDate": 1712246265502,
"paidAmount": 10,
"totalAmount": 10,
"coverCount": 4,
"gratuityAmount": 0,
"receiptNumber": "R90826.1",
"accountObjectId": "41910290874562",
"taxAmount": 1.67,
"preTaxAmount": 8.33,
"serviceCharge": 0,
"tableName": "Table 1",
"accountProfileCode": "Reservation",
"accountProfileName": "Reservation",
"accountProfileId": "41910290874559",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1712245742274,
"offset": -240,
"totalDiscount": 0,
"transactionLines": [
{
"id": "1560383093473286",
"accountId": "1560383093473282",
"amount": 10,
"unitAmount": 10,
"quantity": 1,
"nameOverride": "",
"itemDescription": "Burger",
"accountingGroupId": "41910290874411",
"accountingGroupName": "Food",
"itemId": "41910290874538",
"itemSku": "13",
"date": 1712246167871,
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10,
"amountLessTax": 8.33,
"discountedAmount": 0,
"grossUnitAmount": 10,
"activeTax": {
"code": "VAT20",
"description": "VAT 20%",
"rate": 1.2,
"taxIncluded": true
},
"subLines": [],
"modifiers": []
}
],
"paymentLines": [
{
"id": 1560383093473290,
"accountId": "1560383093473282",
"currencyCode": "GBP",
"gratuityAmount": 0,
"amount": 10,
"date": 1712246265418,
"paymentMethod": "CASH",
"paymentMethodDescription": "Cash"
}
],
"discounts": [],
"externalReferences": [
{
"prefix": "TASK",
"reference": "RN-41910290874370-myApp#224"
}
],
"consumerRecord": {
"id": "131001",
"consumerRecordUUID": "309f2a5b-d42e-409e-aad3-1ce92719ce9c",
"consumer": null,
"contactInformation": {
"firstName": "John",
"lastName": "Purple",
"companyName": "",
"city": "",
"taxIdentifier": "",
"emailReceipts": true,
"fullName": "John Purple"
},
"externalReferences": [
{
"key": "myApp",
"reference": "OO.2439.ABC-18"
}
]
},
"currentProductionPhase": 0
},
"businessLocationId": 41910290874370,
"platformRestaurantId": "myApp-restaurant",
"sequenceId": "B90826.21",
"platformReservationId": "224"
}