Guide
Realtime Notifications
YQueue uses Ably to deliver realtime messages to client applications.
Message handling
Compare the recipient fields with your device or installation UUID:
uuids: process the message only if your UUID is listed.kiosk: process the message only on the kiosk with this UUID.ineligible_devices: ignore the message if your UUID is listed.
Each message below describes the action the receiving application should take.
Supported messages
outlet.updated
When an outlet's attributes change, refresh its profile or configuration. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
outlet |
The UUID of the updated outlet. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
configuration.updated
When a device's configuration changes, devices listed in uuids must fetch their latest configuration from the API.
| Attribute | Description |
|---|---|
uuids |
The UUIDs of the devices whose configuration changed. |
logs.upload
Devices listed in uuids must attempt to upload their logs as soon as possible.
| Attribute | Description |
|---|---|
uuids |
The UUIDs of the devices that need to upload logs. |
force_logout
When a device is unlinked from its outlet, devices listed in uuids must immediately run their outlet unlinking workflow.
| Attribute | Description |
|---|---|
uuids |
The UUIDs of the devices unlinked from their outlet. |
models.created
When catalog models are created, applications that use the catalog must attempt to retrieve the models listed in models. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
models |
The UUIDs of the created catalog models. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
models.updated
When catalog models change, applications that use the catalog must attempt to retrieve the models listed in models. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
models |
The UUIDs of the updated catalog models. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
models.deleted
When catalog models are deleted, applications that use the catalog must remove their local copies of the models listed in models. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
models |
The UUIDs of the deleted catalog models. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
inventory.updated
When an inventory entry is created or updated, applications that use inventory must save the supplied entry locally. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
uuid |
The UUID of the inventory entry. |
outlet |
The UUID of its outlet. |
catalog_model |
The UUID of its catalog model. |
catalog_model_type |
The type of its catalog model. |
status |
The inventory status when the message was sent. |
available_quantity |
The available quantity when the message was sent. |
low_stock_notification |
The low-stock notification threshold. |
calculated_at |
The date-time when these inventory values were calculated. |
created_at |
The date-time when the entry was created. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
inventory.deleted
When inventory entries are deleted, applications that use inventory must remove the entries listed in models from their local inventory state. These are inventory entry UUIDs. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
models |
The UUIDs of the deleted inventory entries. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
order.dispatched
When a kiosk order is dispatched to its outlet, process this notification only on the kiosk identified by kiosk.
| Attribute | Description |
|---|---|
uuid |
The UUID of the order. |
kiosk |
The UUID of the kiosk that should process this message. |
order.updated
When an order changes, handle the update through your application's order-sync workflow. The action depends on the application. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
uuid |
The UUID of the order. |
revision |
The order revision when the message was sent. |
status |
The order status when the message was sent. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |
order.ready
When a kiosk order is ready for collection, process this notification only on the kiosk identified by kiosk.
| Attribute | Description |
|---|---|
uuid |
The UUID of the order. |
kiosk |
The UUID of the kiosk that should process this message. |
outlet |
The UUID of the order's outlet. |
number |
The formatted order number, such as YQ-22. |
transaction.updated
When the backend finalises a transaction, handle the update through your application's transaction-sync workflow. The action depends on the application. Ignore the message if your UUID is listed in ineligible_devices.
| Attribute | Description |
|---|---|
uuid |
The UUID of the transaction. |
status |
The transaction status when the message was sent. |
ineligible_devices |
Device or installation UUIDs that should ignore this message. |