Skip to content

Commit b3488ce

Browse files
docs: update curl requests example
1 parent 7f16a18 commit b3488ce

File tree

2 files changed

+36
-6
lines changed

2 files changed

+36
-6
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
U0JBRR+LCAAAAAAABADtW1tvG8cVfi/Q/7BgIyBFM/LcL35zbDkOkMaGraQFIreYq7Q1yWW4pGXD9n/vGXJJkdylTFKylKTlAyXuXHbmm3P5zpmZD3/+U1H0BnFiew+LD/kH/BzaQYSfvcv6vD6eTsp+feyn437vm6bcTicX1TjX+MdFOaonpX9zXtWTarSs8TaO67Ia5irkGB/jZUGItR+Xo0lT+Ci8tUMfQ/Hs9PRFMY6/TmM9qYu3pS38Ty9/WH1j9XI6fOSbhsNpv78oG5TDcjAd/Lx8ZS7MZZ9mNXrBrk3Ozvqo4ckv8yfFomhWXIY8LkxMkNFhZAyjiNOokSbSIyOEjNiqIEhYDG7WDAY+nWGGmw/q+Fp81lrGoXX9mN86GU/jWsk735+G+HRcDZ6VAO/4PVRKtl9vq/UiDkM5PO+q9ZklndU5H1fT0XqltXLbv7Tva1iGrheM7TBUg+UCtcp9NYQXjuNw0lU6GZfn57CAq6uysTJzubLjMsNVXy3oSmme0XGz3L0PZ2dnsJr5+2FBvinyPxmF+YP8fQqylv9+Wp3lalcZIOjpYjIZ1Q8fPLiM7qKq3hzX5SQ+0F5xFbFGQluGuPYW6RQZCphQpZhSNplt/YK6XVQzOXvx/NVpb73Sp41GjUQySZMgmiPmObyPcYxc5AkFQmUMWohI8Ob7epP3o7zqCtPNkq1SNy/NMlUv1OT1aun68A5Ynw1Qw3QweP+fuhoe+2rwID99wDHfDROMJY9WORSswoh7LZHzWCAnUuJacedD+D1ikuEY9a2PF1U/xPExDLn0VYgziEZgaesHZDeEHEhFVMIDOIIgLmRARrKIiGZCCcdBdlpSes8IbZmJUlFjGC4YY2pB32A6oIKgBCRg762Tzsg7mcnVj9erFqyeukdtz9I92/7cVTy+iP5NkapxcbSQgqPCjs+ng2wlN8fkq/7c5/7l6VOMdVvZ5zhxQi3msM7MRQBL64hs4uDDpDJCBROSJa2ml7E8v8iGGVz1FgwJxmazaGSzPf8+rDvkHTEuhyG+y6/cXU7K4WiaR3mlNJudVqM4to0LkpuFC+C7xpoJxul8pl2D3b66HeOctZj7ww5ft2OfW/qdtexX5z/EtzHbDNbR86zOINa1PZ/J2S8bTv918fBh8feyroErzDhXOQYGthC84qx3JY5nvbYPa17QuCWvjfUMlJGyAG5JUOQsUCasjNYiJEU53drFNWK3rLMUP7q1yooY9rg2HDNnkNTMIR7AVxpFLBIeJ0y5cUp1uOWmo2sF9mriXYK7+Gxar/ln20LOMdSWckWYQZqDL+NJcCCbwDhVVCyKIBWN8VYwpPw3BiHphLD98HWX/pQ3Gu3ngFuAZozBpKv8euO3GxjbZaktR7dhZK7BUUgsrU0JCUU4OFmukEuGIeqcgXAnGSI7FXkfHDe98Kz8VnFsCdSGMG0CsBAiIRLQR4ukTdlV4oRsjBRJ47XDhqRI2uRiF6fZMlq34zPpPtyqzTbm8ccV1/imCDHZaX9STKriu5PTQ7mHltQTxgUKSkKMYpNCViWCjAV4VbQ2mpYhu1fuwQ7gHkcrIdzRtQRk0zdfrcW/vgaUP+bg7+OLn04/Pjn54eT05OOzk0dPPr54dPr42cfnL06/f/7jq79+1XrB74qoLIj9j032YTX63eYbliBdC/SOeCyrNXrOdBKCgKf1XoCzAJoMkbNFDGNvTYJQnuvb8bRbedmqp5WYCEw8QYJEBeTJGGQcxK9UBgEBjrQwqi9KVvbytIeO9n/S096ZlnSY62WlvXQD2KYkPEnEJMSMPHFgocpyZJ2xQRvg8rwVOC67uH3dIFozI4VDgUkMvsQ7ZLmjKBjmsDMmMNFyycuO7lw3Dh3tH4M9ccmMZjETp8yeaALDkCJy0bOkaQoat9Nw98ie+AHs6dtp2Q9F1szMmuqinoxzpv1AoiRCBLwiQSwBRwKihJHDNiAZBacqaWU60nL3SZTEPpB1WLOMWWtCS3DRP4s1Z7+SD9uX/zSJYU6p8kyA8QIl5JhqZCJ3SEdmk1POS9cKZnaTyBanuxV45QES+Xy2iWb7DVh52+Pm2UNCrCJBSqDsFqJpDeRdMw76HIiUxkkr2qmIexVMdQCDv9om+uOkD6/xTYkLSix4ckWYh8g+eOR8BMeuMYHADGiv8v/nbbfF27os3UqLtdgm1z0qUFimXGdKfE3OdS9CJ7CyThmGbATSzimGsMfFgJgNxODgghP8Dgkd84JyHBhSDoPP00EjJxVB2BoekmAy6vTbIXSHjvYPQegwBMVUO4yIUzHTk3z6wXAUbSJUGpxMbFmM+yR0+gD3efIu+ukkFpunIGa1dvSW2HKSsDaIJgus3yUHxDcIpBSoHJVe0dD2MffpLc3uQK3sMW0a98/uLb06+fFJ/jujyyumbguMKcoYgyEIIkxwUBwD3wBRQ4ZyRk1SyogDtyy/kLyRPfYsfTUYgA9a+Ic2n20YW91yC5fgFs7OhkcfxrEegXuK/85nAD613UPvshq/gWjkSTneOq23P9tx9/b6pS0nT6vxybsyo8laiDWpXYojU0Ig73LmLDGdz0IJxKI3yoeYmHCHrFGLZd3OApHdF2hpEV4AQrF42YB9qE3wThirQZgDySfHuFLIeJOtg0hBgmKL1Eox3qtNIHttJnQwnn45bKO1RPWrgZ1cfI33z2Q3B1hksJgGg6SUGkhMMsBbpUCUMiWxYJGm9krcYyRH9thS6ERzoezfVuH9dlQPAzMIqyIVFpEAzIYTzZAjYG2ppSLEaIlRLUZ4r2DukanZ2J/JQnno7sxcZI+q6QS6fFxNh5OjA8T3fFiN42Nbxy3BxwFB4S5zbM2zk4VeN9cCFaQ93x3mvMOstsxs1vKzodqO/V/zjmbu16jdY3Cx26KQpvUCuVH2F1/PkVtZkG7olu13C+FmVRenQ4BSEnC1wDEDuBFg5DoEi0Tercr7MQaLa9+4Qyg3q/fZcG5Way2ko1RjmTCSIkGE6aVDWvqIEnGaSmD7uu3r1jrbKaybY3FdaJc/HeFd/nSFePMObzyDfWLkbTmSWZ3Ph3yzand+Ouk3oZBdfnCj9VpOZbXd0V3pqE/CYKuBllgO7NjbfIIrMSSUiCbqkEPoe9JRZVlwgWtEY4ShYWaR80QhHynRjgOv9y0CtdbZvevoTWawr452pWRmdb6Ijt7G8TccXOIgb/nEO3iH4ME7YIyEtFyyvNdB1E3yVO2UzSYcPSaMJ0zkUz8KbKjBDjkcKcLJStAERonvdFBfPvm7c7jS1F7nRFfmovjbTRjR4kYRDdI5hqzIhzw9x8jYnCuiHFi5TJzgG2Xhu03CXS/UgQnHQ0a2W2Civ0xgssd+6EoirXUL4XOJtJcnj3/Of39Z2x59vXpfAEpnd+eOWjR2W7rNYa5VtBJMhqGIW+qQpZKBPTXUWUHAwrZS2/ebblvfHr36sXYBw1f9vh3VMXyXr7G1yMgBMnbAwYYDTpIesNWwW4J+BafFvw12C9zmtxbX9g8X+cr1h5fR1ZV/Eyev4vhtc02vXfi4XzaJzKvCSTlY1M9PmiuZV9dDG6vVi+9G1XgSQ77G2GtujTa5iPYFz/mdUmT7owt7nG9CffovujfcHsc6AAA=
1+
U0JBRR+LCAAAAAAABADtXVlvW8cVfi/Q/0CwEZCiGXn2xW+KrcQB0tiwlbRA7BazSqy5lZf0Utv/vWcuF3G5XERSpOSID7KlOXfuzFm/c2bhpz//qVart2Lf1h/XPuVf4Ne2bUX4tf6+uCxOB/1Gszj1g16z/t2o3Q76V51epvjHVaNb9Bv+7WWn6He6E4p3sVc0Ou1MQk7xKZk0hFj4XqPbHzWehXe27WOoPbu4eFHrxf8OYtEvau8atuZ/ffnz9Bs7LwftMz96sD1oNsdtrUa70Rq0fpu8Mjfmti8lRT3YmcnZso8C/vL78C+1cVPZ3Ah5XJiYIKPDyBhGEadRI02kR0YIGbFVQZAwHlz5GAx8UPIMjz6o4sf4M/NkbFvXjPmt/d4gzrR88M1BiD/0Oq1nDWBv7yMQJdssllG9iO3QaF9WUa0RaUlz2esMurNEM+22+d5+LEAMVS/o2XbotCYCWmj3nTa8sBfb/arWfq9xeQkCnJbKnGSGemV7jcyu4lqgU615Rqd5VjCHq36/Wzx+9CgMWq2P/yk67VPfaT3qgpoWj0h99tEv3829ZqgEWmmuKLGI8ABKIC1GlrmIKBeWCCKpxLE+/2j/YzczWmE637JU0NdiLMaa+Wa69cv1L2+mmVYM3NmiMlexbSz9F7ZXxNrLoZnVznqXgxYIpFiYhO80S/ueMrNJ21DQFUJcM6aKcZVPvLPNoeU8uYr+bS11erWTsSBPanY0xvkhzgyz/pcffsBY40qioSw5oRZzGRAIMCKudUQ28SxVZYQKJiRLKh9/HxuXV1ln8Smuah/Jm2Bsqpq7Nqv8T0OnYjU1URnkSVSIhyCQpSwgL52jGHMmXPUUVmrOcJLtED/kQc63zat2tQwa7e4gz/Hagqpe0unGnh3Zt6wiGIuyQm3K9uzFL4b8WjaR1fqzZPzlkyv18gb9r3hH2UOzc/lzfBezk2FL3lLStWJR2MtSs3+f87pvao8f1/7eKApw1mXQa/QgBI5Vvfa6fm0Ar+tVopi8ZKjczGtjPSNIZ3UCPaLIWYhbWBmtRUiKcrqymzVKPqGbKDtdSTat9FwbjpkzSGrmQOk5Q0aBTxUeJ0y5cUqZlWNbq/zXzFhmBOPPojGMP6sEPgoGlnJFmEEQE2AeSXBABAALVFQsiiAVjQvBYKabm/KY8jvMYrKUxdUNb5bZY2PnGWzC2DFTjTGYLKOZYukSB1aSbcSs1bpYrYf7dGxr+C0kltamhIQiHOAtV8glwxB1zgC2TQbAzb74PY+DJjS3wu9KxaxQyioGjZVRiMS9tkjalAECTsjGSJE0XjtsSIpE7gQVKp3noZHCAqM2QwpVaA2yx6tOuMZq39VCTHbQ7Nf6ndqP5xe7YjctqSeMCxSUZIjbpJBViSBjQVAqWhtNpeu9Z9iN7ojdhqBhJIy1AK4Ku1xL91/fgtw+v3j+Cn78evH56fnP5xfnn5+dnz39/OLs4smzz89fXPz0/JdXf/2m8kVfBdAb55q/jJKnKfaujKYTJq4VyOSR9fyakI58FNNJCAJoxHsB6giJjRbCIoaxtyYJbbneLxpZiXWnLUViIjDxBInSUpgxyDgsEJVBaMiaLYzwYIBvKzSyywwe0EhJdQesb0ngmRDe2OYA6UvCk0RM6ggZAIcMQFmOrDM2aAN5Fq8sIUy6uT2bI1ozI4VDgUkMEdI7ZLmjKBjmsDMmMFEJWSadHd3mdpnB149IuWRGs5jBaEakNIFDShG56FnSNAWNK43ifiFStiMi/X7QaIZa9hMZiRa1ot/LxfAdwacIETgfCWIJcCeAT4wctgHJKDhVSSsTK1PTewY++bbMr/DSmfuVw5mICv2zth6tbgAiR4s1nFLlGTAF2IE4phqZyB3SkdnklAM2VWazm5tHJVg+sITEgoRm/zDvP8bM2WJkqxgz7UgX2lY70DUrIJWRZVYNN1vXeBZtyGtJx1zVmK2oXw1HdGq9j93qtYyvr7i+JuKHJKNxNKCoHAeUDT80A9DNFaM+iUC4rzSZsotbQNl1yKgwlooiQnQATy/Bg4j8a6AS/L42iS6t8P7BcPgyDz/11EwOnOlPauhZ7XX9rDSBxyP/P2sY61Y7bgzZmaVE+yiRlAY0iwJ4tzoaRCLR1rqkZXXwnnRze5A9WisIh5TdOgvAzgiCXPISBeyC1ioSH1cnOkeH7LvM4DYg+yENeA+gftvR7hHUW+cD9SYh730urBKPHMEcEWwZ85J4x9JdWJCeeIly31Hjf8M4+RBFc95MqI+YEUgIFeTNSgtkKARVp7Vk0hkB8O+gUZSBa8UOlAj7ADrlNSTyQoNiORKpwVyFJB6i6M5RdNoSFoLpdOPeY6q0jBoRc3rFDWRbPrt9SIgDOC5ChCCWHCumQq7H8koRotwKMAZjkWMKAj9jQVnjTPKV/mzS2dFj6i4zuJWYekBz3kNM3Xa09yumbrl0Wx1Tfafdh8GXLuAhombuBOuItx4pI8AEic0CZCHX+nUIjpLIli6t3UpExdQ66bDNmzXA4WrwuuVmL8aiU5ppptJDXrpzRP21iD10dglcnw+nUxay92Cqk4Q8QMkM/QG+caJyZd8gGpOlmvPEFT9SMOUpMQPODHmW47yRYAeJRRRjUB6yPWz1HV/H3WUGtxJMD2jJewim2472fgXTXXfdzLiKATiR0oc8hNLMG+Wk5QRSBSeEBwxrwbuB3FCg3FutDElEHTSUOuy5FpoiS3kCj0AkuFtAikFw50KyMVTrU9nRQyide+rmoXRiH3sPpAkclbRBIx08qFqyHGlImhDFjDuBfVTL85Sym9sLpCZJ4hJmSEHMgZyOCmSSxgh44nTCKkS8emhHD6S7zOBWAukB7XgPgXTb0d6vQLq4fWP2D0vWp7cZ2XHXp2c0YrP16WfgyZvXC9RP84nU+e6PcubueXkS1zZHfjofld3fmTtCrCJBgrZb6wBAJoI0AwswgUhpABuI6iMz+9w64wyz1HqDpBByWK202lFkiNbGaYZ59UmHQy9xhAqVKMn+cKAxcUGJhfitCEBFTgM4BB85iA0TK5KBdNk/7L69R5AwTA40lu5l38hPYGWdMgzZmHePUGyQdjEgZgMxOLjgxLFKKMwLyjFEeuWwAgcI8NRJRRC2hockmIz6jq9H7DKDr35bLtZCUO0wIk7FvDU0XxJhOMDiRKg0OJlY6an2iOsOEN4WVxs2wnXbjOy4uG6mErQZrjv/EP2gH2vzV2mURIcEdFOH0qti2trD6K/Of3ma/y13T0977+uT6CuAXooyxmAIShzgO+cYMB4YATKUM2qSUkbseLnCekswShDitIPsQRrEfeDIqZQQi5RZrLR37kh7WXyn1QJxj8No9V7nyVUcc9Fz6ioM9B4C6evX7ZNPvVh0QTniv30nxC/VAbX+vtN722hfPm0s0cHR5N/9ZstrVz5VAZH6e9vo/9DpnX9oZCmxSimMVjIojkwJgbzLJ9IS0/myHAH890b5EBMTbhcdqMS+B1aALV3hNiM7riucyeVvtgV7qJlHzm4rwGuz0a5ONieg9ZuW7V99i7c/0joKfDJYTAMEPil13nNqIPBJgShlSmIBQk/VSfP+TiNErCQDQIWEz5BYg8JZLAzCPEWheABrrPbHt+4LK0Uzdmffd8LH1SLaTTJBWBWpsIiEvDuEaJZLTQlRS0WI0RJTvdh6vySz6+6Qk4m57HqIfGhQJ51BH7p+0hm0+yc7GNdlu9OLT2wRV2S/O1QyNp3/Ag+Wpjar+FBDNVLNiw35seFsV8y47GGjesIN3rXmfWVPK33AE0A0q1LiUQ9jznZz1Pl2yNkpwS1n7aSPzesMJfn4EiAXBAFUkywOiOe0T4dgkcgH7vORcbN6KafsasN6Q0m7Uc2hpJypO1CqsUwYcq8EXsbnreXSR5QAhVAJaaVOK28HKDvcuPZQUq+tP+TPkhpE/iyrQww738usblroWVUgLOk2q0uUpEe/xOrOGfqyYD/Xw0xBcfrZk0Pbvk/CYKsByFkOCY7PK8wkMSSUiCZCJLcbGNXt276yLLjANaIxwjAxs8h5opCPlGjHIU1bfqxu0uGds/1dZ7WN7S+rR5Z0t2r7+75dDQeXOOhrSsBB7oKHqIUxEtJyyfIJ6f1sw6muV5YUM9FJGE+YyNc55Z3tBkNijCNFOFkJVsUo8XfohMiNksnRE7O479o11f62D9Q3vqGYBukcQ1bk+wg9x8jYIJDKt9MqmTjBe1kmW+5+jiXUfZwT2HK0m2eC+g5kgltubZyqJVe5wLW15JfnT37L//4+c8XDm+lSJrSWF36fLGD/VWVmh7lW0UrwY4YibqlDlkoGQcBQl8+i4h330WxQZj6A2LbcSLPNyI5bZZy5c2TZJde+02zabhHDj/l28gVMusXdOFtc8LiFw9hCHlssKG5xiniLlbktdrBtsXt8i9NbW+we26Iav9kdKlP6O/7vSKfH+jz8koCZPTDjxaHZP76Pruj4t7H/KvbejW7FX2x80myMVoyuG/uN1pg+/2X0DQjX38YwCub1+KHb6fVjyN8akJ1H/pKGUe1z8fsUylaMbLN7ZU/z3flf/g8dg2EYNmIAAA==

streamerbot/4.examples/curl-requests.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,17 +64,47 @@ Optional data to include in the request body, for methods like `POST` or `PUT`.
6464
If passing JSON data, ensure it is properly stringified and escaped.
6565
For example, `{"key":"value"}`{lang=json} would need to be passed as `{\"key\":\"value\"}`{class="text-warning"}
6666
:::
67+
68+
:::field{name="curl.headers.accept" type=string}
69+
Optional value for the `Accept` header to specify the expected response format.
70+
<br><br>
71+
For example, `application/json` to indicate that you expect a JSON response.
72+
:::
73+
74+
:::field{name="curl.headers.authorization" type=string}
75+
Optional value for the `Authorization` header to include credentials or tokens for authentication.
76+
<br><br>
77+
For example, `Bearer your_token_here` for bearer token authentication.
78+
79+
::::warning
80+
If you have debug logging enabled, you can disable the logging sub-action in the `wsgs.utils.curl` action to prevent sensitive data from being logged.
81+
::::
82+
:::
83+
84+
:::field{name="curl.headers.contentType" type=string}
85+
Optional value for the `Content-Type` header to specify the format of the request body.
86+
<br><br>
87+
For example, `application/json` if you are sending JSON data in the request body.
88+
:::
89+
90+
:::field{name="curl.headers.userAgent" type=string}
91+
Optional value for the `User-Agent` header to specify the client making the request.
92+
<br><br>
93+
For example, `MyStreamerBotClient/1.0` to identify your Streamer.bot instance in the request.
94+
:::
6795
::
6896

6997
### Example
7098

7199
For example, to make a `POST` request with a JSON body, you could set your arguments as follows:
72100

73-
| Argument | Value |
74-
| ------------- | ----------------------------------------------------------- |
75-
| `curl.method` | `POST` |
76-
| `curl.url` | `https://webhook.site/f96fee22-c3f1-4aeb-84a0-3ee22ffc651c` |
77-
| `curl.data` | `{\"id\": 1, \"name\": \"Test\"} ` |
101+
| Argument | Value |
102+
| -------------------------- | ----------------------------------------------------------- |
103+
| `curl.method` | `POST` |
104+
| `curl.url` | `https://webhook.site/f96fee22-c3f1-4aeb-84a0-3ee22ffc651c` |
105+
| `curl.data` | `{\"id\": 1, \"name\": \"Test\"} ` |
106+
| `curl.headers.accept` | `application/json` |
107+
| `curl.headers.contentType` | `application/json` |
78108

79109
Then simply run the `wsgs.utils.curl` action to send the request with the specified arguments:
80110

0 commit comments

Comments
 (0)