docs: prefer query params for integrations

cpvalente · May 8, 2024 · 8a4ddd5 · 8a4ddd5
1 parent 0e0e975
commit 8a4ddd5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/content/docs/api/protocols/http.mdx b/src/content/docs/api/protocols/http.mdx
@@ -134,7 +134,7 @@ The payload response is the current state of the message data
 ### Example: change the external text
 **Request**
 ```bash
-<localhost:4001>/api/message/external/text/new-text
+<localhost:4001>/api/message/external?text=new text
 ```
 
 **Response**
@@ -148,7 +148,7 @@ The payload response is the current state of the message data
             "blackout":false
         },
         "external": {
-            "text":"new-text",
+            "text":"new text",
             "visible":false
         }
     }

diff --git a/src/content/docs/api/protocols/websockets.mdx b/src/content/docs/api/protocols/websockets.mdx
@@ -136,7 +136,7 @@ Message: {
     "type": "message", 
     "payload": {
         "external": {
-            "text": "new-text"
+            "text": "new text"
         }
     }
 }
@@ -154,7 +154,7 @@ Message: {
             "blackout":false
             },
         "external":{
-            "text":"new-text",
+            "text":"new text",
             "visible":false
         }
     }