Akece supports WebSocket connections to enable real-time communication between client and server. This type of connection is ideal for instantly receiving messages, status updates, and other live events on the dashboard.
Why use WebSocket?
-
Enables real-time communication with the Akece dashboard
-
Improves agent productivity
-
Eliminates the need to refresh the page to see new messages
Connection URL
To connect via WebSocket, use the following URL:
arduino
Authentication
You will need a PubSub token to authenticate the connection. There are two types:
-
User token (agent or admin): grants access to all events
-
Contact token: limited to events for the active customer session
Example: Establishing a connection
javascript
Presence Updates
To keep the user or contact status as "online", send a presence update every 30 seconds.
For agent/admin
javascript
For contact
javascript
Supported Events
Akece sends real-time event payloads that reflect the current state of the platform. Here are some common events:
-
conversation.created
: New conversation started -
conversation.read
: Message read by the contact -
message.created
: New message sent -
message.updated
: Message edited -
conversation.status_changed
: Conversation status changed -
conversation.typing_on
: User is typing -
conversation.typing_off
: Typing stopped -
assignee.changed
: Assigned agent changed -
team.changed
: Team changed -
contact.created
: New contact created -
contact.updated
: Contact details updated -
presence.update
: Online status changed -
notification.created
: Notification received
Each event includes a payload with detailed data about the related object (conversation, message, contact, user, or notification).
If you need help setting up your WebSocket connection with Akece, contact our team:
📩 [email protected] | 📱 @akece.ai