From 1338aef2bd292ad643e466f75197cab9cb271c3a Mon Sep 17 00:00:00 2001 From: Georgi Baychev Date: Wed, 29 Sep 2021 13:55:12 +0200 Subject: [PATCH] Update websockets.md - specify that the websockets are not meant for external usage/3rd party clients (see #10764) - add a the missing slash at the '/websocket/' URL --- docs/websockets.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/websockets.md b/docs/websockets.md index 12b81248b4..a9fcd43926 100644 --- a/docs/websockets.md +++ b/docs/websockets.md @@ -1,6 +1,6 @@ # Channels Overview -Our channels/websocket implementation handles the communication between AWX API and updates in AWX UI. +Our channels/websocket implementation handles the communication between AWX API and updates in AWX UI. Note that the websockets are not meant for external use and 3rd party clients. ## Architecture @@ -34,7 +34,7 @@ Upon receiving the payload, AWX decrypts the `secret` header using the known sha ## Protocol -You can connect to the AWX channels implementation using any standard websocket library by pointing it to `/websocket`. You must +You can connect to the AWX channels implementation using any standard websocket library by pointing it to `/websocket/`. You must provide a valid Auth Token in the request URL. Once you've connected, you are not subscribed to any event groups. You subscribe by sending a `json` request that looks like the following: