SAsalesforce
botActions

Create botAction

Create a new botAction with a name, room id and bot id

post/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

Request body

namestring required

Name of the botAction

isPendingboolean

If the botAction is active

parametersobject[]

Array of objects that contain the name of actions a botAction can take and an array of parameters needed for that action

responseobject

A JSON field that contains the output of an action

roomIdinteger required

The room in which this action is in reference with

botIdstring required

The bot of which this action is in reference with

userIdstring

The user of which this action is in reference with

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Created 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

Changes

No recorded changes to this operation across all 70 revisions of this API.