Skip to content

Integration

Outreach is a near-leaf service. Its only runtime integration is JWT verification against Identity's JWKS; its only outbound signal is a WebSocket broadcast consumed by the BO dashboard.

1. Sister Services

Direction: calls / called by / bidir.

SisterDirectionSurfaceContractAuthFailure ModeIdempotency
@nx/identityJWKS endpoint (remote)VerifierApplication verifies ES256 JWT— (public JWKS)reject request (401) if JWKS unreachablen/a
BO dashboardWebSocket room subscribeINQUIRY_SUBMITTED payloadWS sessionclient re-fetches via REST if event missedn/a

No HTTP calls to other BANA services. No Kafka topics consumed or produced. @nx/core is the only internal code dependency.

2. External Systems

SystemDirectionSurfaceAuthFailure Mode
PostgreSQLPostgresCoreDataSource (schema outreach)DB credentialsrequest fails on connection loss
RedisWebSocket pub/sub fan-outpassword (optional)WS notify skipped if emitter not ready

No email/SMTP provider is wired despite the package's "Communications" tagline — newsletter delivery is out of scope (see Domain Model).

3. Critical Cross-Service Flows

3.1 Real-time inquiry notification to BO

StepDetail
2Notify is fire-and-forget after the row is committed
3Two rooms: list room (outreach/inquiries) and per-inquiry room
4BO must already have an open WS session subscribed to the room

4. Contract Stability

SurfaceStabilityVersioning
HTTP /inquiries/submit, /subscribers/subscribe, /subscribers/unsubscribestableURL /v1/
HTTP /subscribers/statisticsbeta (shape may grow)URL /v1/
WS observation/outreach/inquiry/submittedbetapath-based; payload additive

Proprietary and Confidential. Unauthorized copying, distribution, or use of this software is strictly prohibited.