Real Time Notification Examples
Introduction
Real Time Notifications allow integrators to be notified of account activity at the URL of their choosing. By default, updates are sent for OPEN, UPDATE, CLOSE and CANCEL events, but the conditions that trigger a notification can be configured. There is also an option to configure authentication credentials to be included in the notification request. Currently, this feature needs to be set up manually by Lightspeed Support teams.
Below you will find examples of RTN payloads sent to configured URLs.
Note
Realtime Notification openDate and closeDate data is provided in the unix timestamp format. It is possible that notifications will be received out of order, for example, the UPDATE notification may arrive before the OPEN notification.
Examples
Notification Type: OPEN
Sent when a new account is created.
{
"notificationType": "OPEN",
"account": {
"id": 1803306443735041,
"uuid": null,
"businessLocationId": 141948669132802,
"name": "floor plan test, Table 1",
"accountNumber": "A104966.1",
"currencyCode": "CAD",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"openDate": 1733863866392,
"closeDate": null,
"paidAmount": 0,
"totalAmount": 13.51,
"coverCount": 2,
"gratuityAmount": 0,
"receiptNumber": null,
"cancelled": false,
"accountProfileCode": "HH",
"transactionLines": [
{
"id": 1803306443735042,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 9,
"unitAmount": 9,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Hamburger",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133196,
"itemSku": "52",
"date": 1733863874244,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [
{
"id": 1803306443735043,
"parentLineId": 1803306443735042,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1,
"unitAmount": 1,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Extra Cheese",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133068,
"itemSku": "35",
"date": 1733863875340,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 1.15,
"amountLessTax": 1,
"discountedAmount": 0,
"grossUnitAmount": 1
}
],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10.35,
"amountLessTax": 9,
"discountedAmount": 0,
"grossUnitAmount": 9
},
{
"id": 1803306443735044,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1.75,
"unitAmount": 1.75,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Coke Zero",
"accountingGroupId": "141948669132844",
"accountingGroupName": "NA beverages",
"itemId": 141948669133025,
"itemSku": "24",
"date": 1733863881389,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Misc"
},
{
"category": "TEST",
"value": "NA beverages"
}
],
"amountWithTax": 2.01,
"amountLessTax": 1.75,
"discountedAmount": 0,
"grossUnitAmount": 1.75
}
],
"paymentLines": [],
"discounts": [],
"externalReferences": [],
"deliveryInformation": {
"id": null,
"enabled": false,
"deliveryMode": null,
"deliveryState": null,
"collectionCode": null,
"deliveryInfo": null,
"deliveryComment": null,
"deliveryDueTime": null,
"deliveryTime": null,
"deliveredTime": null,
"productionDueTime": null,
"prepaid": false,
"deliveryOrigin": null,
"deviceName": null
},
"consumerRecord": null,
"currentProductionPhase": 0,
"currentInsertionPhase": 0,
"accountObjectId": 141948669132977,
"paymentInProgress": false,
"latestExternalReferences": [],
"taxAmount": 1.76,
"preTaxAmount": 11.75,
"serviceCharge": 0,
"orderMode": "DIRECT",
"tableName": "Table 1",
"accountProfileName": "Happy Hour",
"accountProfileId": "141948669133215",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1733863922248,
"offset": -300,
"totalDiscount": 0,
"status": "open"
},
"event": null,
"retryCounter": 0,
"businessLocationId": 141948669132802
}
Notification Type: UPDATE
An update notification is executed for any modification on the account. For example: adding items or applying payments.
{
"notificationType": "UPDATE",
"account": {
"id": 1803306443735041,
"uuid": null,
"businessLocationId": 141948669132802,
"name": "floor plan test, Table 1",
"accountNumber": "A104966.1",
"currencyCode": "CAD",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"openDate": 1733863866392,
"closeDate": null,
"paidAmount": 0,
"totalAmount": 13.51,
"coverCount": 2,
"gratuityAmount": 0,
"receiptNumber": null,
"cancelled": false,
"accountProfileCode": "HH",
"transactionLines": [
{
"id": 1803306443735042,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 9,
"unitAmount": 9,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Hamburger",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133196,
"itemSku": "52",
"date": 1733863874244,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [
{
"id": 1803306443735043,
"parentLineId": 1803306443735042,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1,
"unitAmount": 1,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Extra Cheese",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133068,
"itemSku": "35",
"date": 1733863875340,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 1.15,
"amountLessTax": 1,
"discountedAmount": 0,
"grossUnitAmount": 1
}
],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10.35,
"amountLessTax": 9,
"discountedAmount": 0,
"grossUnitAmount": 9
},
{
"id": 1803306443735044,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1.75,
"unitAmount": 1.75,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Coke Zero",
"accountingGroupId": "141948669132844",
"accountingGroupName": "NA beverages",
"itemId": 141948669133025,
"itemSku": "24",
"date": 1733863881389,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Misc"
},
{
"category": "TEST",
"value": "NA beverages"
}
],
"amountWithTax": 2.01,
"amountLessTax": 1.75,
"discountedAmount": 0,
"grossUnitAmount": 1.75
}
],
"paymentLines": [],
"discounts": [],
"externalReferences": [],
"deliveryInformation": {
"id": null,
"enabled": false,
"deliveryMode": null,
"deliveryState": null,
"collectionCode": null,
"deliveryInfo": null,
"deliveryComment": null,
"deliveryDueTime": null,
"deliveryTime": null,
"deliveredTime": null,
"productionDueTime": null,
"prepaid": false,
"deliveryOrigin": null,
"deviceName": null
},
"consumerRecord": null,
"currentProductionPhase": 0,
"currentInsertionPhase": 0,
"accountObjectId": 141948669132977,
"paymentInProgress": false,
"latestExternalReferences": [],
"taxAmount": 1.76,
"preTaxAmount": 11.75,
"serviceCharge": 0,
"orderMode": "DIRECT",
"tableName": "Table 1",
"accountProfileName": "Happy Hour",
"accountProfileId": "141948669133215",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1733863922248,
"offset": -300,
"totalDiscount": 0,
"status": "open"
},
"event": null,
"retryCounter": 0,
"businessLocationId": 141948669132802
}
Notification Type: CLOSE
{
"notificationType": "CLOSE",
"account": {
"id": 1803306443735041,
"uuid": null,
"businessLocationId": 141948669132802,
"name": "floor plan test, Table 1",
"accountNumber": "A104966.1",
"currencyCode": "CAD",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"openDate": 1733863866392,
"closeDate": 1733864409584,
"paidAmount": 13.51,
"totalAmount": 13.51,
"coverCount": 2,
"gratuityAmount": 1,
"receiptNumber": "R104966.1",
"cancelled": false,
"accountProfileCode": "HH",
"transactionLines": [
{
"id": 1803306443735042,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 9,
"unitAmount": 9,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Hamburger",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133196,
"itemSku": "52",
"date": 1733863874244,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [
{
"id": 1803306443735043,
"parentLineId": 1803306443735042,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1,
"unitAmount": 1,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Extra Cheese",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133068,
"itemSku": "35",
"date": 1733863875340,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 1.15,
"amountLessTax": 1,
"discountedAmount": 0,
"grossUnitAmount": 1
}
],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10.35,
"amountLessTax": 9,
"discountedAmount": 0,
"grossUnitAmount": 9
},
{
"id": 1803306443735044,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1.75,
"unitAmount": 1.75,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Coke Zero",
"accountingGroupId": "141948669132844",
"accountingGroupName": "NA beverages",
"itemId": 141948669133025,
"itemSku": "24",
"date": 1733863881389,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Misc"
},
{
"category": "TEST",
"value": "NA beverages"
}
],
"amountWithTax": 2.01,
"amountLessTax": 1.75,
"discountedAmount": 0,
"grossUnitAmount": 1.75
}
],
"paymentLines": [
{
"id": 1803306443735046,
"accountId": 1803306443735041,
"currencyCode": "CAD",
"gratuityAmount": 1,
"amount": 13.51,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"date": 1733864409579,
"active": true,
"paymentMethod": "CASH",
"paymentMethodDescription": "Cash",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"externalReference": null
}
],
"discounts": [],
"externalReferences": [],
"deliveryInformation": {
"id": null,
"enabled": false,
"deliveryMode": null,
"deliveryState": null,
"collectionCode": null,
"deliveryInfo": null,
"deliveryComment": null,
"deliveryDueTime": null,
"deliveryTime": null,
"deliveredTime": null,
"productionDueTime": null,
"prepaid": false,
"deliveryOrigin": null,
"deviceName": null
},
"consumerRecord": null,
"currentProductionPhase": 0,
"currentInsertionPhase": 0,
"accountObjectId": 141948669132977,
"paymentInProgress": false,
"latestExternalReferences": [],
"taxAmount": 1.76,
"preTaxAmount": 11.75,
"serviceCharge": 0,
"orderMode": "DIRECT",
"tableName": "Table 1",
"accountProfileName": "Happy Hour",
"accountProfileId": "141948669133215",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1733863922248,
"offset": -300,
"totalDiscount": 0,
"status": "closed"
},
"event": null,
"retryCounter": 0,
"businessLocationId": 141948669132802
}
Notification Type: CANCEL
{
"notificationType": "CANCEL",
"account": {
"id": 1803306443735041,
"uuid": null,
"businessLocationId": 141948669132802,
"name": "floor plan test, Table 1",
"accountNumber": "A104966.1",
"currencyCode": "CAD",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"openDate": 1733863866392,
"closeDate": 1733864409584,
"paidAmount": 13.51,
"totalAmount": 13.51,
"coverCount": 2,
"gratuityAmount": 1,
"receiptNumber": "R104966.1",
"cancelled": true,
"accountProfileCode": "HH",
"transactionLines": [
{
"id": 1803306443735042,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 9,
"unitAmount": 9,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Hamburger",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133196,
"itemSku": "52",
"date": 1733863874244,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [
{
"id": 1803306443735043,
"parentLineId": 1803306443735042,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1,
"unitAmount": 1,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Extra Cheese",
"accountingGroupId": "141948669132845",
"accountingGroupName": "Food",
"itemId": 141948669133068,
"itemSku": "35",
"date": 1733863875340,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 1.15,
"amountLessTax": 1,
"discountedAmount": 0,
"grossUnitAmount": 1
}
],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Food"
}
],
"amountWithTax": 10.35,
"amountLessTax": 9,
"discountedAmount": 0,
"grossUnitAmount": 9
},
{
"id": 1803306443735044,
"parentLineId": null,
"accountId": 1803306443735041,
"currencyCode": null,
"amount": 1.75,
"unitAmount": 1.75,
"quantity": 1,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"nameOverride": "",
"itemDescription": "Coke Zero",
"accountingGroupId": "141948669132844",
"accountingGroupName": "NA beverages",
"itemId": 141948669133025,
"itemSku": "24",
"date": 1733863881389,
"active": true,
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"activeTax": {
"code": "MULTI",
"description": "MULTI",
"rate": 1.14975,
"taxIncluded": false
},
"subLines": [],
"discounts": [],
"modifiers": [],
"tags": "",
"phase": 0,
"categories": [
{
"category": "default",
"value": "Misc"
},
{
"category": "TEST",
"value": "NA beverages"
}
],
"amountWithTax": 2.01,
"amountLessTax": 1.75,
"discountedAmount": 0,
"grossUnitAmount": 1.75
}
],
"paymentLines": [
{
"id": 1803306443735046,
"accountId": 1803306443735041,
"currencyCode": "CAD",
"gratuityAmount": 1,
"amount": 13.51,
"staffId": 14670,
"staffName": "Manager",
"staffEmail": null,
"date": 1733864409579,
"active": true,
"paymentMethod": "CASH",
"paymentMethodDescription": "Cash",
"deviceId": 104966,
"deviceName": "iPad15",
"deviceIp": null,
"externalReference": null
}
],
"discounts": [],
"externalReferences": [],
"deliveryInformation": {
"id": null,
"enabled": false,
"deliveryMode": null,
"deliveryState": null,
"collectionCode": null,
"deliveryInfo": null,
"deliveryComment": null,
"deliveryDueTime": null,
"deliveryTime": null,
"deliveredTime": null,
"productionDueTime": null,
"prepaid": false,
"deliveryOrigin": null,
"deviceName": null
},
"consumerRecord": null,
"currentProductionPhase": 0,
"currentInsertionPhase": 0,
"accountObjectId": 141948669132977,
"paymentInProgress": false,
"latestExternalReferences": [],
"taxAmount": 1.76,
"preTaxAmount": 11.75,
"serviceCharge": 0,
"orderMode": "DIRECT",
"tableName": "Table 1",
"accountProfileName": "Happy Hour",
"accountProfileId": "141948669133215",
"originAccountId": null,
"originAccountNumber": null,
"type": "SALE",
"updateDate": 1733863922248,
"offset": -300,
"totalDiscount": 0,
"status": "cancelled"
},
"event": null,
"retryCounter": 0,
"businessLocationId": 141948669132802
}