Communication: hbf-core
1-hop view of how this service communicates with its siblings. For the full system view, see service-communication.md.
Calls Out To
| Service | Protocol | Purpose | Key calls / queues |
|---|---|---|---|
| helvia-rag-pipelines | HTTP Bearer | RAG pipeline management | POST/PUT/GET /pipelines/{id} for train, process, corpus, status |
| SDS (Semantic Doc Segmenter) | HTTP multipart | File processing for knowledge base | POST/GET/PATCH /jobs |
| hbf-lcm | HTTP Bearer | Live chat data management | DELETE /organizations/{orgId}/data, DELETE /organizations/{orgId}/data-retention |
| hbf-notifications | HTTP Bearer | Send notifications | POST /organizations/{orgId}/notifications/ |
| AutoBot | HTTP Bearer | Automated bot testing | POST/GET/DELETE /tests |
| Data Manager | HTTP Bearer | Interaction data cleanup | DELETE /chat-sessions/{sessionId}/interactions, POST bulk delete |
| LanguageTool | HTTP | Grammar/spell checking | POST /check (URL-encoded form) |
| DirectLine (Bot Framework) | HTTP | WebChat token management | https://directline.botframework.com/v3/directline |
| Azure Speech | HTTP | Speech service tokens | Azure Speech API |
| UptimeRobot | HTTP | Health monitoring | UptimeRobot API |
| Google Translate API | HTTP Bearer | Translation | Google Translate API |
| Azure AI | HTTP | Language detection | Azure AI Language API |
| Microsoft OAuth | OAuth2 | Authentication flows | OAuth2 token endpoints |
| Google OAuth | OAuth2 | Authentication flows | OAuth2 token endpoints |
Called By
| Service | Protocol | How |
|---|---|---|
| All services (via hbf-core-api) | HTTP REST | 27 client classes in hbf-core-api library proxy to hbf-core |
| hbf-console | HTTP REST | Primary backend for the admin console |
| hbf-webchat | HTTP GET | /public/bot-deployments/{id} |
Contracts
Inbound
hbf-core exposes the primary REST API consumed by all other services. The full API surface is defined by the 27 client classes in the hbf-core-api library, including:
- Tenant, organization, and user management
- Bot content, deployments, and responses
- Subscribers and groups
- Chat sessions and handover
- NLP pipelines and NLU detection
- Knowledge base and articles
- Broadcasts, surveys, integrations
- Analytics and audit logs
- Public endpoints (e.g.,
GET /public/bot-deployments/{id})
Outbound
- helvia-rag-pipelines:
POST /pipelines/{id}:train,:process,PUT /pipelines/{id}/corpus,GET /pipelines/{id}-- Bearer auth - SDS:
POST /jobs(multipart file upload),GET /jobs/{id},PATCH /jobs/{id}-- job lifecycle - hbf-lcm:
DELETE /organizations/{orgId}/data,DELETE /organizations/{orgId}/data-retention-- Bearer auth - hbf-notifications:
POST /organizations/{orgId}/notifications/-- Bearer auth - AutoBot:
POST /tests,GET /tests/{id},DELETE /tests/{id}-- Bearer auth - Data Manager:
DELETE /chat-sessions/{sessionId}/interactions,POSTbulk delete -- Bearer auth - LanguageTool:
POST /check-- URL-encoded form body - DirectLine: Token generation and refresh at
https://directline.botframework.com/v3/directline - OAuth providers: Microsoft and Google OAuth2 token exchange flows
Environment Variables
| Variable | Target |
|---|---|
GPT_PIPELINE_URL | helvia-rag-pipelines |
HELVIA_SDS_URL | SDS (Semantic Doc Segmenter) |
LIVECHAT_URL | hbf-lcm |
NOTIFICATION_URL | hbf-notifications |
AUTO_BOT_URL | AutoBot |
DATA_MANAGER_URL | Data Manager |
LANGUAGE_TOOL_URL | LanguageTool |
DIRECTLINE_BASEURL | DirectLine (Bot Framework) |
CHATBOTS_BASEURL | hbf-bot (health check) |