Session Events | Machani Robotics SDK

SessionEvents subscribes a user to real-time session events.

Use this method to receive a stream of events (e.g., messages, join/leave notifications) as they happen in the specified session.

Request: SessionEventsRequest (specify session name and username) Response: stream of SessionEventsResponse (real-time event updates)

HTTP: GET /v1/conversation/sessions/{name}/events

SessionEvents subscribes a user to real-time session events. Use this method to receive a stream of events (e.g., messages, join/leave notifications) as they happen in the specified session. Request: SessionEventsRequest (specify session name and username) Response: stream of SessionEventsResponse (real-time event updates) HTTP: GET /v1/conversation/sessions/{name}/events

Path parameters

sessionstringRequired

The session id.

Query parameters

sessionstringOptional

Session is the session object to join.

channelintegerOptional

Channel is the channel to subscribe to for session events.

Response

eventstring

Event is the event message for the session.

messageobject

Message is the message associated with the event.

Errors

400

Bad Request Error

1	{
2	"event": "message_received",
3	"message": {
4	"channel": 2,
5	"message": "Hello team, the new robot prototype is ready for testing tomorrow at 10 AM.",
6	"data": {
7	"senderId": "user_12345",
8	"timestamp": "2024-06-15T09:45:00Z",
9	"messageId": "msg_98765"
10	}
11	}
12	}