v1

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

Get botAction

get/botActions/{key}

Path parameters

keystring required

The id or name of the botAction to retrieve

Query parameters

isPendingboolean

Get botActions depending on its pending tag

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 specified botAction

idstring

The UUID of the specified bot action

namestring

The name of the bot action requested

isPendingboolean

If the action is still pending completion

parametersobject[]

The values required to run a bot action

responseobject

The output of an bot action

roomIdinteger

The room ID in which the bot action deals with

botIdstring

The bot ID in which the bot action deals with

userIdstring

The user ID in which the bot action deals with