Add Shutdown API Documentation

cueglow · Mar 29, 2022 · 57352c8 · 57352c8
1 parent d4b7f4b
commit 57352c8
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/dev-docs/Client-Server API.md b/dev-docs/Client-Server API.md
@@ -442,6 +442,16 @@ a ping message every minute:
 }
 ```
 
+## Shutdown
+
+To shutdown the server process, the client can send:
+
+```json
+{
+    "event": "shutdown"
+}
+```
+
 ## Old Ping API (NOT IMPLEMENTED)
 
 To ensure a good user experience, the server and client require a reliable and