Docs

getState

Retrieves the State object for a valid identifiers.

GET/v1/chat/states/{type}/{id}/{name}

Authorization

AuthorizationBearerrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias

Path parameters

typeenum<string>required
Represents the resource type that the state is related to
Available options:"conversation","user","bot","integration","workflow"
idstringrequired
Id of the State which will be either the botId, the userId or the conversationId
namestringrequired
Name of the State which is declared inside the bot definition

Response

application/json

Returns the State object if a valid identifiers were provided. Returns an error otherwise

The response is of type getStateResponse · object.

stateobjectrequired
The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
metaobjectrequired