Sending Requests

Learn how to send requests to the WebSocket server
Check out the Streamer.bot Client library if you are using JavaScript or TypeScript!

Request Format

Requests can be made to the server in stringified JSON format.

Request Schema
{
  "request": "<request>",
  "id": "<id>"
}

Properties

request
string required
The name of the request to be made
id
string
A unique identifier for the request, which will be included in the response

Response Format

Response Schema
{
  "status": "ok" | "error",
  "id": "<id>"
}

Properties

status
string required
The status of the request, either ok or error
id
string
The unique identifier for the request, if provided