Integrate Oquira queue management directly on your website.
The Oquira widget allows you to integrate ticket taking and queue status display directly on your website, without visitors needing to download the app.
| Type | Description | Use Case |
|---|---|---|
| Queue Status | Shows number of people waiting | Inform before travel |
| Join Queue | Allows taking a ticket | Online ticket taking |
| Display Board | Call screen for waiting rooms | TV screen display |
Get information needed to display a widget.
GET /v1/widget/organization/{organizationId}/info
X-API-Key: your_api_key_herePublic endpoint to display queue status without authentication.
GET /v1/widget/queue/{queueId}/statusAllow web visitors to take a ticket.
POST /v1/widget/queue/{queueId}/join
X-API-Key: your_api_key_here
Content-Type: application/json
{
"visitorName": "John Smith",
"phone": "+14155551234",
"partySize": 1
}| Property | Type | Required | Description |
|---|---|---|---|
visitorName | string | No | Visitor name |
phone | string | No | Phone for notifications |
partySize | number | No | Number of people |
Optimized endpoint for waiting room display screens.
GET /v1/widget/organization/{organizationId}/display-board
X-API-Key: your_api_key_here<!-- Oquira Widget -->
<div
id="oquira-widget"
data-organization="org_xyz..."
data-queue="que_123..."
></div>
<script src="https://widget.oquira.com/v1/embed.js" async></script>window.OquiraWidget = {
organizationId: "org_xyz...",
queueId: "que_123...",
theme: "light", // or 'dark'
language: "en", // or 'fr'
showEstimatedWait: true,
allowJoin: true,
onTicketCreated: function (ticket) {
console.log("Ticket created:", ticket.displayCode);
},
};Connect to WebSocket for real-time updates.
const ws = new WebSocket("wss://api.oquira.com/v1/widget/ws");
ws.on("message", (data) => {
const event = JSON.parse(data);
if (event.type === "queue_update") {
updateQueueDisplay(event.data);
}
});
// Subscribe to a queue
ws.send(
JSON.stringify({
action: "subscribe",
queueId: "que_123...",
}),
);| Option | Description |
|---|---|
theme | light or dark |
primaryColor | Primary color (hex) |
language | fr or en |
showLogo | Show organization logo |
compact | Compact mode for small spaces |