ContextVariable webhook

post

https://api.digitalcx.com/Contextvariablewebhook

Describes the web hook call done for the context variable web hook 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body sent to the configured web hook URL.

sessionId

string

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

culture

string

The culture used to select the answer content for this request.

correlationId

string

Guid generated for each context variable web hook request so that the specific interaction can be correlated to the APM logging.

user

object

Object representing the user linked to the session.

session

object

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

input

object

Object containing the input provided to the Gateway API by the end-user.

contextVariables

array of objects

Array containing the context variables available for this request.

contextVariables

request

object

Object containing additional information related to the interaction with the Gateway API that may be of value in setting the context for the interaction.

Response

200OK