Communication: hbf-lcg
Outbound HTTP Calls
| Target | Method | Endpoint | Purpose | Auth |
|---|---|---|---|---|
| hbf-core | GET | /tenants/{tenantId}?includePlugins=true | Fetch tenant config with livechat plugin | Bearer HBF_CORE_API_TOKEN |
| hbf-core | GET | /organizations/{organizationId} | Fetch organization data | Bearer HBF_CORE_API_TOKEN |
| hbf-lcm | POST | /livechat-requests | Create Helvia internal livechat request | Bearer HBF_LCM_TOKEN |
| hbf-bot | POST | /livechat-events | Deliver transformed downstream events | None |
| hbf-event-publisher | POST | /connectors/flows:trigger | Trigger flows on livechat events | Bearer HBF_CORE_API_TOKEN |
| Genesys Cloud | POST | /api/v2/conversations/messages | Create/send messages | OAuth2 |
| Genesys Cloud | GET | /api/v2/conversations/messages | Fetch messages | OAuth2 |
| Genesys Cloud | PUT | /api/v2/conversations/messages/{id} | Update conversation state | OAuth2 |
| Genesys Cloud | — | WebSocket | Real-time event streaming | OAuth2 |
| Cisco WebEx | GET | Events endpoint | Poll for contact center events (5s interval) | API key |
| Zendesk Sunshine | — | Conversations API | Poll conversations, post messages | API key |
Inbound HTTP Endpoints
Upstream (from hbf-bot) -- JWT protected
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /requests | Create livechat request |
| PATCH | /requests/subscribers/:subHandle | Update request by subscriber |
| DELETE | /sessions/tenants/:tenantId/subscribers/:subHandle | Terminate session |
| POST | /messages | Forward user message |
| HEAD | /organizations/:organizationId/requests?status= | Count requests (X-Total-Count header) |
| HEAD | /organizations/:organizationId/tenants/:tenantId/metrics | Avg wait time (X-Average-Waiting-Time header) |
| GET | /subscribers/:subHandle/livechat-state | Get subscriber status |
| GET | /tenants/:tenantId/availability | Get availability + business hours |
Downstream (webhook callbacks from external services)
| Method | Endpoint | Purpose |
|---|---|---|
| POST | /events/:alias | Receive events from livechat providers (helvia-livechat, cisco-livechat, genesys-livechat, zendesk) |
| HEAD | /events/:alias | Health check |
Async Communication
| Channel | Type | Purpose |
|---|---|---|
| Redis pub/sub | Microservice transport | Cluster coordination: heartbeat, correlated RPC, leader election, instance shutdown |