v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
events

Find events

All events are retrieved using this route and using the paramaters as filters you can focus on rooms, bots, or users.

get/events

Query parameters

roomIdinteger

Get events from specific room

botIdstring

Get events from specific bot

typestring

Get events that are a specific type

actionTypestring

Get events that are a specific actionType

sortstring

Specify the sort order using a field name, e.g. '...?sort=createdAt'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

botDataIdstring

Get events from specific botData

botActionIdstring

Get events from specific botAction

userIdstring

Get events from specific user

createdAtstring

Filter by time period when events were created.

updatedAtstring

Filter by time period when events were updated.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns all Events

idstring

The UUID of the specified event

logstring

Human readable log line describing the event and its context it stores

contextobject

A object, typically JSON, that contains the information to describe an event

actionTypestring

This is the type of the event

roomIdinteger

The room ID in which the event deals with

botIdstring

The bot ID in which the event deals with

botDataIdstring

The bot data ID in which the event deals with

botActionIdstring

The bot action ID in which the event deals with

userIdstring

The user ID in which the event deals with