Skip to main content

Example Webhook Notifications

Introduction​

Below are some detailed examples of order notifications that will be sent to the configured webhook URL for a reservation integration. It is likely that several UPDATE notifications will be sent for each order, for example when items are added, or when payments are applied.

General examples of reservation webhooks, including error, integration, and onboarding notifications, can be found in the API Reference.

Examples​

Tax Inclusive​

Regular Reservation​

{
  "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"
}

Split check​

When an order is split on a POS, technically a new order is created, and selected items are moved from the original order to the new one (original order UPDATE, and split order OPEN notifications are sent). Two resulting orders are paid independently (two order CLOSE notifications are sent).

Attributes to detect a split order:

  • "type": "SPLIT", for regular orders (including the original) the value is "SALE"
  • "originAccountId" and "originAccountNumber" are set to the original order's identifiers in the split order
{
  "notificationType": "OPEN",
  "account": {
    "id": "2190678134095876",
    "businessLocationId": "1340570962231298",
    "name": "Uno Cafe, Table 10",
    "accountNumber": "A127514.1",
    "currencyCode": "EUR",
    "staffId": "224812",
    "staffName": "Manager",
    "openDate": 1767009229897,
    "closeDate": null,
    "paidAmount": 0,
    "totalAmount": 50.71,
    "coverCount": 2,
    "gratuityAmount": 0,
    "receiptNumber": null,
    "orderMode": "TABLE",
    "accountObjectId": "1340570962231448",
    "taxAmount": 8.45,
    "preTaxAmount": 42.26,
    "serviceCharge": 0,
    "tableName": "Table 10",
    "tableNumber": 10,
    "tables": [
      "10"
    ],
    "accountProfileCode": null,
    "accountProfileName": null,
    "accountProfileId": null,
    "originAccountId": null,
    "originAccountNumber": null,
    "type": "SALE",
    "updateDate": 1767013602149,
    "offset": 240,
    "totalDiscount": 0,
    "transactionLines": [
      {
        "id": "2190678134095877",
        "accountId": "2190678134095876",
        "amount": 11.42,
        "unitAmount": 11.42,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "Aglio Olio",
        "accountingGroupId": "1340570962231457",
        "accountingGroupName": "Food",
        "itemId": "1340570962231468",
        "itemSku": "3",
        "date": 1767013596486,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "[]"
          }
        ],
        "amountWithTax": 11.42,
        "amountLessTax": 9.52,
        "discountedAmount": 0,
        "grossUnitAmount": 11.42,
        "activeTax": {
          "code": "TVAN20",
          "description": "TVA 20%",
          "rate": 1.2,
          "taxIncluded": true
        },
        "subLines": [],
        "modifiers": []
      },
      {
        "id": "2190678134095878",
        "accountId": "2190678134095876",
        "amount": 10.34,
        "unitAmount": 10.34,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "Creamy Carbonarra",
        "accountingGroupId": "1340570962231457",
        "accountingGroupName": "Food",
        "itemId": "1340570962231464",
        "itemSku": "2",
        "date": 1767013597170,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "[]"
          }
        ],
        "amountWithTax": 10.34,
        "amountLessTax": 8.62,
        "discountedAmount": 0,
        "grossUnitAmount": 10.34,
        "activeTax": {
          "code": "TVAN20",
          "description": "TVA 20%",
          "rate": 1.2,
          "taxIncluded": true
        },
        "subLines": [],
        "modifiers": []
      },
      {
        "id": "2190678134095879",
        "accountId": "2190678134095876",
        "amount": 10.22,
        "unitAmount": 5.11,
        "quantity": 2,
        "nameOverride": "",
        "itemDescription": "Lemonade",
        "accountingGroupId": "1340570962231457",
        "accountingGroupName": "Food",
        "itemId": "1340570962231484",
        "itemSku": "7",
        "date": 1767013597639,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "[]"
          }
        ],
        "amountWithTax": 10.22,
        "amountLessTax": 8.52,
        "discountedAmount": 0,
        "grossUnitAmount": 5.11,
        "activeTax": {
          "code": "TVAN20",
          "description": "TVA 20%",
          "rate": 1.2,
          "taxIncluded": true
        },
        "subLines": [],
        "modifiers": []
      },
      {
        "id": "2190678134095880",
        "accountId": "2190678134095876",
        "amount": 6.22,
        "unitAmount": 6.22,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "Mango Orange Juice",
        "accountingGroupId": "1340570962231457",
        "accountingGroupName": "Food",
        "itemId": "1340570962231488",
        "itemSku": "8",
        "date": 1767013599022,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "[]"
          }
        ],
        "amountWithTax": 6.22,
        "amountLessTax": 5.18,
        "discountedAmount": 0,
        "grossUnitAmount": 6.22,
        "activeTax": {
          "code": "TVAN20",
          "description": "TVA 20%",
          "rate": 1.2,
          "taxIncluded": true
        },
        "subLines": [],
        "modifiers": []
      },
      {
        "id": "2190678134095881",
        "accountId": "2190678134095876",
        "amount": 12.51,
        "unitAmount": 12.51,
        "quantity": 1,
        "nameOverride": "",
        "itemDescription": "Tuna Pesto",
        "accountingGroupId": "1340570962231457",
        "accountingGroupName": "Food",
        "itemId": "1340570962231472",
        "itemSku": "4",
        "date": 1767013600506,
        "tags": "",
        "phase": 0,
        "categories": [
          {
            "category": "default",
            "value": "[]"
          }
        ],
        "amountWithTax": 12.51,
        "amountLessTax": 10.43,
        "discountedAmount": 0,
        "grossUnitAmount": 12.51,
        "activeTax": {
          "code": "TVAN20",
          "description": "TVA 20%",
          "rate": 1.2,
          "taxIncluded": true
        },
        "subLines": [],
        "modifiers": []
      }
    ],
    "paymentLines": [],
    "discounts": [],
    "externalReferences": [],
    "consumerRecord": null,
    "currentProductionPhase": 0
  },
  "businessLocationId": 1340570962231298,
  "platformRestaurantId": "352734",
  "sequenceId": "B127514.12",
  "platformReservationId": null
}

Reservation With Deposit​

{
  "notificationType": "OPEN",
  "account": {
    "id": "1717802234806337",
    "businessLocationId": "40570261078018",
    "name": "Table 8",
    "accountNumber": "A99989.3",
    "currencyCode": "GBP",
    "staffId": "200470",
    "staffName": "Reservation_System",
    "openDate": 1726687023480,
    "closeDate": null,
    "paidAmount": 0,
    "totalAmount": 0,
    "coverCount": 2,
    "gratuityAmount": 0,
    "receiptNumber": null,
    "accountObjectId": "40570261078330",
    "taxAmount": 0,
    "preTaxAmount": 0,
    "serviceCharge": 0,
    "tableName": "Table 8",
    "tableNumber": 8,
    "accountProfileCode": "Reservation",
    "accountProfileName": "Reservation",
    "accountProfileId": "40570261078341",
    "originAccountId": null,
    "originAccountNumber": null,
    "type": "SALE",
    "updateDate": 1726687023497,
    "offset": -240,
    "totalDiscount": 0,
    "transactionLines": [],
    "paymentLines": [],
    "discounts": [],
    "externalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-40570261078018-myApp#342"
      }
    ],
    "consumerRecord": {
      "id": "133871",
      "consumerRecordUUID": "29698d4a-2e57-4c7e-b649-1bcac8a41fd6",
      "consumer": null,
      "contactInformation": {
        "firstName": "John",
        "lastName": "Smith",
        "companyName": "",
        "city": "",
        "taxIdentifier": "",
        "emailReceipts": false,
        "fullName": "John Smith"
      },
      "externalReferences": [
        {
          "key": "myApp",
          "reference": "OO.2361.ABC-123"
        }
      ]
    },
    "currentProductionPhase": 0
  },
  "businessLocationId": 40570261078018,
  "platformRestaurantId": "myApp-restaurant",
  "sequenceId": "B99989.73",
  "platformReservationId": "342"
}

Tax Exclusive​

Regular Reservation​

{
  "notificationType": "OPEN",
  "account": {
    "id": "1717819414675479",
    "businessLocationId": "141948669132802",
    "name": "Table 1",
    "accountNumber": "A99990.2",
    "currencyCode": "CAD",
    "staffId": "206458",
    "staffName": "Reservation_System",
    "openDate": 1726689736130,
    "closeDate": null,
    "paidAmount": 0,
    "totalAmount": 0,
    "coverCount": 2,
    "gratuityAmount": 0,
    "receiptNumber": null,
    "accountObjectId": "141948669132977",
    "taxAmount": 0,
    "preTaxAmount": 0,
    "serviceCharge": 0,
    "tableName": "Table 1",
    "tableNumber": 1,
    "accountProfileCode": "Reservation",
    "accountProfileName": "Reservation",
    "accountProfileId": "141948669133267",
    "originAccountId": null,
    "originAccountNumber": null,
    "type": "SALE",
    "updateDate": 1726689736141,
    "offset": -240,
    "totalDiscount": 0,
    "transactionLines": [],
    "paymentLines": [],
    "discounts": [],
    "externalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-141948669132802-myApp#438"
      }
    ],
    "consumerRecord": {
      "id": "139604",
      "consumerRecordUUID": "880ad209-c061-41be-9aab-4779e5673d73",
      "consumer": {
        "id": "78277",
        "emailAddress": "john.smith@email.com"
      },
      "contactInformation": {
        "firstName": "John",
        "lastName": "Smith",
        "companyName": "",
        "city": "",
        "taxIdentifier": "",
        "emailReceipts": false,
        "fullName": "John Smith"
      },
      "externalReferences": [
        {
          "key": "myApp",
          "reference": "OO.8262.ABC-123"
        }
      ]
    },
    "currentProductionPhase": 0
  },
  "businessLocationId": 141948669132802,
  "platformRestaurantId": "myApp",
  "sequenceId": "B99990.31",
  "platformReservationId": "438"
}

Reservation With Deposit​

{
  "notificationType": "OPEN",
  "account": {
    "id": "1717819414675459",
    "businessLocationId": "141948669132802",
    "name": "Table 1",
    "accountNumber": "A99990.1",
    "currencyCode": "CAD",
    "staffId": "206458",
    "staffName": "Reservation_System",
    "openDate": 1726688878361,
    "closeDate": null,
    "paidAmount": 0,
    "totalAmount": 0,
    "coverCount": 2,
    "gratuityAmount": 0,
    "receiptNumber": null,
    "accountObjectId": "141948669132977",
    "taxAmount": 0,
    "preTaxAmount": 0,
    "serviceCharge": 0,
    "tableName": "Table 1",
    "tableNumber": 1,
    "accountProfileCode": "Reservation",
    "accountProfileName": "Reservation",
    "accountProfileId": "141948669133267",
    "originAccountId": null,
    "originAccountNumber": null,
    "type": "SALE",
    "updateDate": 1726688878382,
    "offset": -240,
    "totalDiscount": 0,
    "transactionLines": [],
    "paymentLines": [],
    "discounts": [],
    "externalReferences": [
      {
        "prefix": "TASK",
        "reference": "RN-141948669132802-myApp#94"
      }
    ],
    "consumerRecord": {
      "id": "139604",
      "consumerRecordUUID": "880ad209-c061-41be-9aab-4779e5673d73",
      "consumer": {
        "id": "78277",
        "emailAddress": "john.smith@email.com"
      },
      "contactInformation": {
        "firstName": "John",
        "lastName": "Smith",
        "companyName": "",
        "city": "",
        "taxIdentifier": "",
        "emailReceipts": false,
        "fullName": "John Smith"
      },
      "externalReferences": [
        {
          "key": "myApp",
          "reference": "OO.8262.ABC-123"
        }
      ]
    },
    "currentProductionPhase": 0
  },
  "businessLocationId": 141948669132802,
  "platformRestaurantId": "myApp",
  "sequenceId": "B99990.11",
  "platformReservationId": "94"
}