Skip to main content

Communication: hbf-webchat

1-hop view of how this service communicates with its siblings. For the full system view, see service-communication.md.

Calls Out To

ServiceProtocolPurposeKey calls / queues
hbf-coreHTTP GETDeployment config, Direct Line token URL/public/bot-deployments/{deploymentId}
Direct Line (Bot Framework)WebSocketBidirectional chat messagingWebSocket connection for send/receive
Azure Cognitive ServicesHTTPSpeech-to-Text / Text-to-SpeechToken URL obtained from core config (azureSpeechTokenURL)

Called By

ServiceProtocolHow
(none -- browser widget)BrowserEnd users load the widget directly

Contracts

Inbound

None. This is a client-side widget loaded by end users in the browser.

Outbound

  • hbf-core: GET /public/bot-deployments/{deploymentId} -- fetches deployment configuration including tokenURL and azureSpeechTokenURL.
  • Direct Line: WebSocket protocol per Bot Framework Direct Line spec. Token obtained via tokenURL from core config.
  • Azure Speech: HTTP token exchange via azureSpeechTokenURL from core config, then streaming audio for STT/TTS.

Environment Variables

VariableTarget
tokenURL (from core config)Direct Line token endpoint
azureSpeechTokenURL (from core config)Azure Speech token endpoint

Flows Involving This Service