Developer Overview
WebChatAgent offers multiple integration paths for developers, from simple widget embedding to full API access for custom implementations.
Integration Options
Widget Embed (Fastest)
Add the chatbot to any website with a single script tag or custom element. Ideal for websites and web apps where you want a ready-made chat interface.
- Widget Embed Guide — Script tag, custom element, styling, and event handling
REST API
Build custom chat interfaces, integrate into mobile apps, or create server-to-server workflows. The REST API provides a simple request/response model for sending messages and receiving replies.
- REST API Reference — Endpoints, authentication, request/response format, and examples
WebSocket API
For real-time live chat integration where you need instant message delivery, typing indicators, and status updates. Ideal for building custom live chat dashboards or agent interfaces.
- WebSocket API Reference — Connection, events, authentication, and examples
Which Should I Use?
| Use Case | Recommended |
|---|---|
| Add chatbot to a website | Widget Embed |
| Custom chat UI or mobile app | REST API |
| Real-time live chat dashboard | WebSocket API |
| Server-to-server automation | REST API |
Explore Use Cases for practical implementation examples.
