SK Queue · Developers

API Integrations & Contracts

Enforce fair lines, receive real-time webhook dispatches, and trigger allocation checks atomically.

Ecosystem Topology

Integration Architecture

SK Queue is a stateless waitlist decider. It queries availability from Calendar, reads customer IDs from CRM, and dispatches SMS/WhatsApp alerts via Notifications over the Backbone.

API Quickstart

Add customers to the queue, verify sessions, and listen to seat allocations in three steps.

# 1. Join the Queue curl -X POST https://api.softknack.com/v1/queue/join \ -H "Authorization: Bearer $JWT_TOKEN" \ -H "Idempotency-Key: idemp_key_99182" \ -H "Content-Type: application/json" \ -d '{ "customerId": "ctc_01HXYZ789", "partySize": 4, "matchType": "FITTED", "resourceType": "table", "metadata": { "zone": "AC" } }' # Response: # { # "id": "que_01J8F9087", # "status": "waiting", # "position": 3, # "estimatedWaitSeconds": 720 # }
import axios from 'axios'; // 1. Join the Queue const response = await axios.post('https://api.softknack.com/v1/queue/join', { customerId: 'ctc_01HXYZ789', partySize: 4, matchType: 'FITTED', resourceType: 'table', metadata: { zone: 'AC' } }, { headers: { 'Authorization': `Bearer ${jwtToken}`, 'Idempotency-Key': 'idemp_key_99182' } }); console.log(response.data);
import requests # 1. Join the Queue url = "https://api.softknack.com/v1/queue/join" headers = { "Authorization": f"Bearer {jwt_token}", "Idempotency-Key": "idemp_key_99182" } payload = { "customerId": "ctc_01HXYZ789", "partySize": 4, "matchType": "FITTED", "resourceType": "table", "metadata": { "zone": "AC" } } response = requests.post(url, json=payload, headers=headers) print(response.json())

Signed Webhooks

Ecosystem dispatches use uniform HMAC envelopes to guarantee event integrity. Validate signature in header X-Nexus-Signature.

Event Type Description Trigger Condition
queue.entry.joined Party joined line successfully Fires upon validated OTP check-in
queue.entry.allocated Resource assigned, party seated Fires when fitted allocation checker commits transaction
queue.entry.cancelled Party dropped or removed from line Fires when guest cancels session or response timer expires

Ecosystem Guarantees

All Softknack downstream APIs conform to six architectural guarantees.

01 Multi-tenant RLS

Dataset isolation is forced in PostgreSQL tables, filtering queries via session org keys.

02 Append-only audit

Mutation operations are blocked by triggers; all modifications append to event logs.

03 Strict Idempotency

Operations require key validation, returning existing models on matching requests.

04 Correlation tracing

Propagates tracking correlation IDs to trace operations across all services.

05 Verification gates

OTP check-ins guard queue entries, validating client numbers before lines form.

06 DPDP retention

PII fields are automatically sanitized when sessions checkout or expire.

Model Context Protocol

AI Client Tool Mapping

SK Queue registers tools natively on the Backbone SSE Gateway. AI receptionists interact with the queue dynamically.

Start building with fair queues.

Integrate waiting dispatches into your applications in minutes. Explore full documentation or request developer credentials.

Read Docs  Get API Keys →