Grid Queues API reference

Owned by Former user (Deleted)
Last updated: May 14, 2024 by Kamil Placzek
2 min read

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.

Region

URL

Region

URL

EU

https://api.omborigrid.com/regions/eu/queues/v1/organizations/{tenantId}

US

https://api.omborigrid.com/regions/us/queues/v1/organizations/{tenantId}

IN

https://api.omborigrid.com/regions/in/queues/v1/organizations/{tenantId}

AU

https://api.omborigrid.com/regions/au/queues/v1/organizations/{tenantId}

UAE

https://api.omborigrid.com/regions/uae/queues/v1/organizations/{tenantId}

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 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.