Skip to main content

Integration Overview

All external access to the Smart Corridor platform goes through the Hub's single /graphql endpoint, served by the GraphQL API. This one endpoint covers both subscriptions (live notifications over WebSocket or SSE) and queries (historical data retrieval over HTTP POST). Partners, integrators, and the bundled GUI all integrate the same way — no other service exposes an external interface.

Live subscriptions​

Each of the 13 notification topics is exposed as an individual GraphQL subscription — for example identificationClearanceGreen, identityCreated, or zoneOccupancyViolation. Consumers subscribe only to what they need. A combined events(filter: EventFilter) subscription is also available for those who prefer a single stream with optional type filtering. The full topic list is in the Event Catalog.

Historical queries​

Persisted events are queryable by event type, time range, unit ID, correlation ID, and source system, with paginated results in chronological order. Retention is short and configurable — see Event Storage & Retention.

VPP proxy queries​

Management data — cameras, watchlists, and members — is owned by the internal Video Processing Platform but exposed through the same unified API: the GraphQL API delegates these queries to VPP transparently and stores no local copy. Integrators never interact with VPP directly.

Stability guarantees​

The event model is designed for forward compatibility. When eGate-specific notifications diverge from corridor notifications, prefixed topics (corridor.*, egate.*) will be introduced without removing existing subscriptions — the single /graphql endpoint and unified event model remain stable. A REST API offering the same event model over HTTP is planned.

In this section​