Reference material for teams integrating with or building on Civiq.plus. Full API reference and schema documentation are provisioned with your environment; this page covers the shape of the system and where to start.
Full reference documentation is environment-scoped. API schemas, event contracts and the data dictionary are provisioned alongside your deployment so they match the hierarchy and modules you actually run.
Sections
Core entities and the common record envelope every object carries — tenant, geography, timestamps, actor and audit metadata.
Core topics, the event envelope, delivery semantics and how to subscribe without polling.
Canonical resource domains, pagination, filtering, idempotency and error semantics.
The default role model, how geography scoping composes with roles, and how to express an authorization rule.
The reference stack, what each layer is responsible for, and which choices are genuinely replaceable.
What a module must satisfy before it ships: contracts, tests, audit coverage, permissions and observability.
Getting started
Deployments that begin with dashboards tend to stall. Deployments that begin with geography and intake tend to keep moving.
Load the hierarchy for your deployment and confirm that every level you operate at resolves cleanly.
Start with the highest-volume channel and get records landing with a resolvable geographic unit.
Let duplicates group into issue clusters and check the clustering against a week of known cases.
Set acknowledgement, assignment and resolution targets per category and severity.
Introduce evidence and independent verification for the categories where closure needs to mean something.
Capture a snapshot before the first intervention so there is something to compare against later.
Reference stack
The architectural commitments are event-driven integration, spatial data as a first-class concern and append-only audit. The specific technologies below are a reference, not a requirement.
| Layer | Reference choice | Responsibility |
|---|---|---|
| Web control room | React, Next.js, TypeScript | Map-heavy real-time dashboards |
| Mobile | Flutter or React Native | Field app with offline support |
| API services | Go, TypeScript or Java | Domain services and gateways |
| AI services | Python with FastAPI | Model orchestration, NLP and retrieval |
| Transactional DB | PostgreSQL with PostGIS | Core entities and spatial queries |
| Analytical DB | ClickHouse | High-volume time series and events |
| Search | OpenSearch | Full-text search across feedback and media |
| Event bus | Kafka or Redpanda | Durable event integration |
| Cache & presence | Redis | Sessions, rate limits, presence, queues |
| Object storage | S3-compatible | Photos, video, documents, audio |
| Vector retrieval | pgvector or a dedicated vector store | Semantic retrieval |
| Real-time media | WebRTC with an SFU | Voice, video and group calls |
| Observability | OpenTelemetry | Tracing, metrics and audit correlation |
| Orchestration | Kubernetes | Regional and national scale with HA |
Tell us what you are integrating and we will get you the right environment and documentation.
