Merge pull request #11163 from gbaychev/patch-1

Update websockets.md
This commit is contained in:
Shane McDonald 2021-10-02 15:17:03 -04:00 committed by GitHub
commit fed94b531d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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: