Integration Guide
Our next-generation API with simplified workflows and improved developer experience.
API Endpoints
Complete API reference with interactive documentation powered by Scalar:
- Streamlined endpoints
- Patient upsert workflows
- Presigned iframe URLs
- Enhanced embedding capabilities
Embedding Scenarios
End-to-end integration patterns and workflows:
- Complete consultation workflows
- iframe embedding examples
- Browser message events
- Implementation guides
Event Delivery Service
Push-based real-time event delivery via WebSocket:
- WebSocket connection and authentication
- Protocol frame reference (event, ack, ping/pong)
- Event types and payloads
- At-least-once delivery and deduplication
Integration Guide (V1)
Our first-generation API built on the FHIR standard, providing comprehensive integration capabilities.
Integration API
The Integration API provides detailed documentation about our RESTful API endpoints:
- Authentication methods
- Available endpoints for various operations
- Request/response formats
- Error handling
Event Delivery Service
Real-time notifications about changes in the Empego system via Server-Sent Events (SSE):
- Available event types
- Event payload structures
- Event delivery mechanisms
IT Deployment Guide
Requirements and setup guidance for IT teams deploying the Empego platform within an organization.
Empego Application Requirements
Guide to deploying the Empego application within your environment:
- Browser compatibility requirements
- Embedded WebView considerations
- Firewall and domain allowlisting
- Pre-production environment access