VueFlow
  1. Event
VueFlow
  • Vueron VueFlow Operation Manual
  • Mbembo
    • User
      • UserLogin
      • RefreshToken
    • Area
      • Stream Area Frame
    • Statistics
      • Get Zone Statistics
      • Get Zone Statistics Client
    • Event
      • Stream Event
        GET
    • AlarmLog
      • Get AlarmLog Count
      • Get AlarmLog List
  1. Event

Stream Event

GET
{{mbembo_ws_url}}/ws/v1/mbembo/event
Websocket

This is Websocket. You can't test through this page#

Try to test this feature via the websocket client.#

Receive events, such as client update or alarm raised.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{dev_mbembo_ws_url}}/ws/v1/mbembo/event?at='
Response Response Example
0 - Alarm - Client Event - Update
{
    "trID": "20250220055703031679",
    "eventVersion": 1,
    "eventType": "Client",
    "actionType": "Update",
    "actor": {
        "uid": "00000000-0000-0000-0000-000000000000",
        "userName": ""
    },
    "payload": {
        "id": 1,
        "createdAt": "2025-02-11T09:59:06.394Z",
        "updatedAt": "2025-02-20T05:57:03.115Z",
        "deletedAt": 0,
        "areaID": 1,
        "name": "local",
        "host": "localhost",
        "port": 10221,
        "fingerprint": "5ab42ecb8ca187d26ac9d63d9b2654e8a347d14706c661098990621833351e3f",
        "frameRate": 100,
        "clientMode": 1,
        "clientStat": {
            "id": 200,
            "createdAt": "2025-02-12 12:49:45",
            "clientID": 1,
            "zoneID": 1,
            "congestionLevel": 1,
            "zoneCount": 2,
            "passingCount": 0,
            "activeLidarCount": 1
        },
        "area": {
            "id": 1,
            "createdAt": "2025-02-11T09:58:53.544Z",
            "updatedAt": "2025-02-11T09:58:53.544Z",
            "deletedAt": 0,
            "name": "local",
            "description": "local",
            "clients": null
        },
        "zones": [
            {
                "id": 1,
                "clientID": 1,
                "name": "liveZone",
                "areaM2": 3288.967,
                "vertices": [
                    {
                        "x": -32.02945,
                        "y": 32.490665
                    },
                    {
                        "x": 28.211512,
                        "y": 32.490665
                    },
                    {
                        "x": 28.211512,
                        "y": -22.106188
                    },
                    {
                        "x": -32.02945,
                        "y": -22.106188
                    }
                ],
                "targetClass": [
                    "CAR",
                    "TRUCK",
                    "PEDESTRIAN",
                    "CYCLIST"
                ],
                "filterClass": null,
                "violationClass": null,
                "targetSides": [
                    {
                        "index": 0,
                        "name": "1",
                        "violationDirection": "In"
                    }
                ],
                "congestionMode": "Simple",
                "congestionLevels": [
                    {
                        "level": 1,
                        "threshold": 1,
                        "rgb": "#349af9"
                    },
                    {
                        "level": 2,
                        "threshold": 11,
                        "rgb": "#e6d806"
                    }
                ]
            },
            {
                "id": 2,
                "clientID": 1,
                "name": "test123",
                "areaM2": 9622.088,
                "vertices": [
                    {
                        "x": -69.52634,
                        "y": -25.850113
                    },
                    {
                        "x": 57.71725,
                        "y": -25.850113
                    },
                    {
                        "x": 57.71725,
                        "y": -101.46954
                    },
                    {
                        "x": -69.52634,
                        "y": -101.46954
                    }
                ],
                "targetClass": null,
                "filterClass": null,
                "violationClass": null,
                "targetSides": null,
                "congestionMode": "Simple",
                "congestionLevels": null
            }
        ]
    }
}

Request

Query Params
at
string 
optional
accessToken
Example:
{{token}}

Responses

⚪0Alarm
application/json
Body
trID
string <YYYYMMDDhhmmssnnxxxx>
required
YYYYMMDDhhmmssminnnn
Example:
20250212174827129876
eventVersion
number 
required
version
eventType
enum<string> 
required
Depends on domain
Allowed values:
NewFrameClientClientStatAlarm
actionType
enum<string> 
required
Event operation type
Allowed values:
CreateUpdateDelete
actor
object 
required
Not used
uid
string 
required
Not used
userName
string 
required
Not used
payload
string  | integer  | boolean  | array  | object  | number  | null 
required
⚪0Client
Modified at 2025-02-12 08:56:28
Previous
Get Zone Statistics Client
Next
Get AlarmLog Count
Built with