Describes the web hook call done for transactional dialog slots when defined. Request body is sent to the web hook URL configured in the Conversational AI Cloud CMS. The response body is the response expected by the Conversational AI Cloud Gateway API.

Log in to see full request history
Body Params

Request body sent to the configured web hook URL.

string

The culture this dialog is defined in, and in which this interaction is taking place.

string

Guid generated for each request to the Gateway API. Points to the session linked to the interaction, and subsequent interactions.

session
object

Object representing the session in which the interaction is taking place. This object consists of the session properties defined for the project.

string

Name of the transactional dialog.

string

The unprocessed input as provided to the Gateway API.

string

The processed input provided to the Gateway API.

string

A value (extracted from the input text) matching the pattern defined on the slot.

string

Name of the slot for which the web hook call is made.

slot
object

Object containing all information configured/provided for the transactional dialog slot.

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json