Integration#

This section provides actions to integrate the interactive system with other apps or services to provide additional capabilities that the Interactive System can leverage.

REST API Call Action#

The system should make a REST API call.

StartRestApiCallBotAction(
request_type: RequestType,
url: str,
headers: Dict[str, Any] | None,
payload: Dict[str, Any] | None,
)#

Start an API call.

Parameters:

  • request_type (RequestType) – Request type

  • url (str) – REST API endpoint

  • headers (Optional[Dict[str, Any]]) – Custom headers

  • payload (Optional[Dict[str, Any]]) – Dict that will be converted to JSON and Content-Type header set to application/json

  • ... – Additional parameters/payload inherited from StartBotAction().

RestApiCallBotActionStarted()#

API call started

Parameters:

... – Additional parameters/payload inherited from BotActionStarted().

RestApiCallBotActionFinished(response: Dict[str, Any])#

API call finished

Parameters:

  • response (Dict[str, Any]) – Response of call

  • ... – Additional parameters/payload inherited from BotActionFinished().

On this page