Skip to main content

Example Webhook Notifications

Introduction​

Below are examples of 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.

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

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