API

General virtual queue documentation is available under Virtual Queues section: Virtual Queues The documentation describes queue setup, management and different features.

This document contains overview of exposed APIs that were used for integration by partners:

• Queue tickets

  • Ticket creation (join the queue) - Create or update ticket (with client / device pingback)  

    • Can be used to create ticket that has customer information attached and join the virtual queue

  • Get ticket - Get position

    • Can be used to retrieve information about ticket, like current status, and present in custom UI

      • Contract description available here Position model

  • Subscribe to ticket changes through websocket/SignalR - SignalR - Get position updates

    • Can be used for real-time UI updates for example when ticket is called forward

• Bookings

  • Get time slots for a queue - Get time slots

    • Can be used to present available time slots for particular queue

  • Create booking - Create booking

    • Can be used to create new booking in a queue

  • Create time slot reservation - Create time slot reservation

    • Can be used to create time slot reservation, i.e. unconfirmed booking

    • Useful for flows where reservation requires confirmation, for example by doing payment

  • Update time slot reservation - Update time slot reservation

    • Can be used to update reservation information (can’t confirm reservation)

  • Confirm time slot reservation - Confirm time slot reservation

    • Can be used to transform time slot reservation into a valid (confirmed) booking, for example, when payment is confirmed

• Common

  • Cancel ticket, booking or reservation - Cancel ticket or reservation

    • Can be used for cancelling any kind of ticket

  • Update ticket, booking or reservation - Update position or reservation

    • Can be used for updating any kind of ticket

• Webhooks - Ombori Grid Virtual Queues solution has webhook mechanism to expose various events happening in the system to a third-party

  • Complete list of available webhooks and payload description is available here: Webhooks integration

  • Webhooks can be configured by Ombori team on queue level

Any other functionality can be exposed and we are expanding the available API as we go, depending on requirements.