POS Subscriptions
Authorization (HMAC)
To verify that the payloads your webhooks receive actually come from us, we require that you implement HMAC authentication schema.
HMAC constructs an information-rich header that contains information about the sender, while providing security to ensure that the request has not been forged or tampered with in transit.
For more information read here
Available Subscriptions
Batch Ticket Updated
This subscription is available only for SkyTab POS.
Sends Batch POS Ticket update notification whenever one of the documented fields has been changed in the POS. This notification happens near to real-time, with up to a 3 minute delay.
Fields and objects that are tracked by this subscription
| Object | Tracked Fields |
|---|---|
| Ticket | posRef, locationId, orderNumber, openedAt, closedAt, guestCount, orderTypeName, orderTypeRef, type, openedByEmployeeRef, totalItems, totalTax, totalGrand, totalDiscounts, totalSurcharges, totalGratuities, tableName, tableRef, ticketSpecialRequests |
| TicketItem | name, price, type, quantity, kitchenSentAt, isOnHold, ticketSpecialRequests |
| TicketItemModifier | name, price, type, quantity |
| TicketPayments | amount, tipAmount, tenderName |
Event Example
{
"event":{
"name":"pos.BatchTicket.updated",
"component":"pos",
"resource":"BatchTicket",
"action":"updated",
"version":"v2",
"subscriptionId":51,
"dispatchedAt":"2023-05-08T11:01:41.592Z"
},
"payload":{
"tickets":[
{
"locationId":2,
"posRef":"3ba13095-93c2-48cc-87d3-e5a8cc21115f"
},
{
"locationId":2,
"posRef":"677f9395-32bf-40cc-81fc-c43d59d7f289"
},
{
"locationId":1,
"posRef":"7840c2dc-4d8f-47ad-97dd-f5fe54942920"
}
]
}
}
Payload
| Name | Type | Description |
|---|---|---|
| tickets | array | Collection of ticket references |
Ticket Reference
| Name | Type | Description |
|---|---|---|
| locationId* | integer | The Lighthouse location ID |
| posRef* | string | The POS Ticket Reference |