Skip to main content

Attendant - SocketIO

The Attendant API publishes async events to the SocketIO service for edge applications to consume.

What is SocketIO and how it works?​

SocketIO service docs

Topics that Attendant API expose​

  • att.private.notification.assistance-requests.v1 - assistance request is created or updated
  • att.private.notification.assistance-request-processed.v1 - assistance request is processed (/act) endpoint is called on assist req
  • att.private.notification.assistance-request-deleted.v1 - assistance request is deleted
  • att.private.notification.baskets.v1 - basket is created or updated
  • att.private.notification.basket-deleted.v1 - basket is deleted
  • att.private.notification.workstations.v1 - workstation is created or updated
  • att.private.notification.workstation-deleted.v1 - workstation is deleted

Note: no message will be published if entity is expired (no updates for 10 days) and is removed from the database.

Full AsyncAPI schema for specified topics can be found here

Note: Please keep in mind that attributes in a schema specified using This-Case, but SocketIO will turn any attribute to thisCase.

How it works?​

For each data mutation for Workstation, Basket or Assistance Request, Attendant API will publish a message to the SocketIO service. Edge application may choose to sub to it to get real-time updates for entities. In attempt to save traffic, we do not include all the data when entity is updated, but only identifiers and fields that changes. Please go through the schema to see what fields are mandatory (marked as required) and what are optional and can be omitted.