SAsalesforce
botActions

Find botActions

Changed on
get/botActions

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/botActions
  • Auth
    API key in header Authorization

Query parameters

roomIdinteger

Get actions from specific room

botIdstring required

Get actions from specific bot

namestring

Get botActions by name

isPendingboolean

Get pending botActions

createdAtstring

Filter by time period when BotActions were created.

updatedAtstring

Filter by time period when BotActions 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 BotActions

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

Changes