Check Websocket

GET

api

events

getWebsocket

:instance

Check Websocket

curl --request GET \
  --url https://api.example.com/api/events/getWebsocket/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/events/getWebsocket/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes

Description

Returns the instance’s current WebSocket configuration. Returns 404 when there is no row in websocket_configs (the instance was never configured via POST), there is no “implicit default config”.

Watch the spelling: the correct path is getWebsocket (lowercase w in socket), different from POST /websocket. This inconsistency is historical, use the exact literal from the registry.

Path parameters

string

required

Instance name.

Example

curl -X GET "https://ryzeapi.cloud/api/events/getWebsocket/$Instance_Name" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/events/getWebsocket/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/events/getWebsocket/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/events/getWebsocket/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Headers

string

required

TokenAccount or TokenInstance.

Success response

Returns the websocket object with the current configuration: enabled, events and mediaBase64. Note: 404 means “never configured” (no row in websocket_configs), different from enabled=false (which returns 200 with the persisted row and the fields cleared). Handle both cases on the client.

200 OK

{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     true,
    "events":      ["message.exchange"],
    "mediaBase64": false
  }
}

200 OK (disabled)

{
  "success": true,
  "message": "WebSocket configuration retrieved",
  "websocket": {
    "enabled":     false,
    "events":      [],
    "mediaBase64": false
  }
}

Errors

HTTP	`error.message`
401	`Invalid token`
404	`Instance not found`
404	`WebSocket not configured for this instance`
429	`Rate limit exceeded. Try again later.`
500	`Failed to get instance`
500	`Failed to get websocket configuration`

Envelope:

{
  "success": false,
  "error": { "message": "WebSocket not configured for this instance" }
}

Notes

404 ≠ “disabled”: 404 means “never created a row”; an enabled=false returns 200 normally with "enabled": false. Handle both cases on the client.
No GET /websocket/:instance alias: unlike the webhook, there is no alias with the “regular” spelling, only getWebsocket (lowercase).

Configure WebSocket

POST /api/events/websocket/:instance

Connect via WebSocket

GET /ws/:instance

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Check Websocket

Description

Path parameters

Example

Headers

Success response

Errors

Notes

Next

Configure WebSocket

Connect via WebSocket

​Description

​Path parameters

​Example

​Headers

​Success response

​Errors

​Notes

​Next

Configure WebSocket

Connect via WebSocket

Description

Path parameters

Example

Headers

Success response

Errors

Notes

Next