Websocket Events in OneChat

Websocket Events

To subscribe to various events happening in your OneChat installation in realtime, you can connect to the OneChat WebSockets.
OneChat WebSockets connection can be made at the following URL.

<your installation url>/cable

Authenticating your WebSocket connection

You will start receiving the events directed towards your customer after subscribing using the customer pubsub_token.
You will start receiving the events directed towards your agents after subscribing using the user pubsub_token.

Also refer Client APIs to build real time customer facing integrations using OneChat.

Example

const connection = new WebSocket('ws://localhost:3000/cable');
connection.send(JSON.stringify({ command:"subscribe", identifier: "{\"channel\":\"RoomChannel\",\"pubsub_token\":\""+ customer_pubsub_token+"\"}" }));

Publishing Presence to the websocket server

Publish the appropriate payloads back to the websocket server at 30 second intervals to keep the online presence updated in OneChat.

Agent presence

{
	"command": "message",
	"identifier": "{\"channel\":\"RoomChannel\",\"pubsub_token\":\"token\",\"account_id\":1,\"user_id\":1}",
	"data": "{\"action\":\"update_presence\"}"
}

Contact Presence

{
	"command": "message",
	"identifier": "{\"channel\":\"RoomChannel\",\"pubsub_token\":\"token\"}",
	"data": "{\"action\":\"update_presence\"}"
}

Websocket Event payload samples

Here are example payloads of various websocket events in OneChat.

conversation_created

Available for: Agents

{
	"identifier": "{\"channel\":\"RoomChannel\",\"pubsub_token\":\"token\",\"account_id\":1,\"user_id\":1}",
	"message": {
		"event": "conversation.created",
		"data": {
			"additional_attributes": {
				"browser": {
					"device_name": "Unknown",
					"browser_name": "Chrome",
					"platform_name": "macOS",
					"browser_version": "92.0.4515.107",
					"platform_version": "10.15.7"
				},
				"referer": "http://localhost:3000/widget_tests",
				"initiated_at": {
					"timestamp": "Fri Jul 23 2021 22:43:14 GMT+0530 (India Standard Time)"
				}
			},
			"can_reply": true,
			"channel": "Channel::WebWidget",
			"id": 7,
			"inbox_id": 1,
			"contact_inbox": {
				"id": 8,
				"contact_id": 10,
				"inbox_id": 1,
				"source_id": "4f5c785e-abba-4527-82a9-bbdb2117c167",
				"created_at": "2021-07-23T17:08:53.771Z",
				"updated_at": "2021-07-23T17:08:53.771Z",
				"hmac_verified": false
			},
			"messages": [],
			"meta": {
				"sender": {
					"additional_attributes": {},
					"custom_attributes": {},
					"email": null,
					"id": 10,
					"identifier": null,
					"name": "white-shadow-394",
					"phone_number": null,
					"pubsub_token": "token",
					"thumbnail": "",
					"type": "contact"
				},
				"assignee": {
					"id": 1,
					"name": "John",
					"available_name": "John",
					"avatar_url": "https://www.gravatar.com/avatar/0d722ac7bc3b3c92c030d0da9690d981?d=404",
					"type": "user",
					"availability_status": "online"
				}
			},
			"status": "open",
			"unread_count": 0,
			"agent_last_seen_at": 0,
			"contact_last_seen_at": 0,
			"timestamp": 1627060394,
			"account_id": 1
		}
	}
}