Page Comparison

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

...

Request authentication

Some endpoints require an organization-level API key, which must be generated by the Ombori team upon request.

API URL

The {base-url} of the Grid Queues API depends on the data residency you’re working with. Make sure you use the correct URL for the data residency assigned to your tenant.

{tenantId} is your tenant identifier, which can be found in Grid Console.

API overview

Queue Tickets

• Ticket Creation (join the queue)

  • Allows the creation of a ticket with attached customer information and the addition of the ticket to the virtual queue.

• Get Ticket

  • Retrieves information about a ticket, including its current status, which can be presented in a custom UI.

• Subscribe to Ticket Changes through WebSocket/SignalR

  • Enables real-time UI updates, such as when a ticket is called forward.

Bookings

• Get Time Slots for a Queue

  • Returns available time slots for a particular queue.

• Create Booking

  • Allows the creation of a new booking in a queue.

• Create Time Slot Reservation

  • Creates a time slot reservation, which is an unconfirmed booking.

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

    doing payment

    Confirm time slot reservation - Confirm time slot reservation

    Can be used to transform

    making a payment.

• Update Time Slot Reservation

  • Updates reservation information.

• Confirm Time Slot Reservation

  • Transforms a time slot reservation into a valid (confirmed) booking, for example, when payment is confirmed.

Common

• Cancel Ticket, Booking, or Reservation

  • Cancels any kind of ticket.

• Update Ticket, Booking, or Reservation

  • Updates any kind of ticket.

• Webhooks

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

  • A complete list of available webhooks and payload descriptions is available here.

  • Webhooks can be configured by the Ombori team at the queue level.

Any other functionality can be exposed, and we are expanding the available API as we go, depending on requirements. Some of endpoints above required organization level ApiKey that has to be generated by Ombori team at a request.