Dialog Events Review

Events review

After clicking the Show Events button, you will be redirected to the board with events message which contains detailed information about the event. The events messages consist of the events’ names and their values.

Each event name goes first and is separated from the value by the semicolon, and the value is separated from the next event name by a comma so the pair looks the following:

EventName1:value1,EventName2:value2,EventName3:value3, …

To see more examples, read the table below:

The events that contain key-value pairs are marked with example values, whereas the events that don’t contain them are masked as --

Event Name	Description	Example Value
`appId`	The ID of the miniApp invoked in this dialog	049c6052-613d-40b2-bc69…GS_Intent.Banking2.MiniApps.gettingStarted
`requestId`	The sessions CCaaS interaction ID (if provided)	135880351342
`sessionId`	The session connection ID. The session ID is comprised of the following attributes separated by a colon : Integration identifier (nic, chat, gen, sip) The tenant ID on the CCAS side Call ID on the CCaaS side	chat:1653567…
`envMode`	Indicates the env mode value of a Web Service miniApp	PROD
`testMode`	Indicates this was a test dialog created by our automated testing systems	false
`Locale`	Indicates the locale value is used to select prompts, grammars, NLU apps and so on	en-US
`Welcome_Announcement`	Indicates that the Welcome Announcement was used	`--`
`Get_Intent:InformationAsked`	Indicates the system action, which performs as the initial prompt for requesting information, was triggered	`--`
`Intent`	Indicates the Intent value understood by the system	Balance-Inquiry
`Intent_Announcement`	Indicates an Announcement that was played to the caller by the Intent miniApp for an Intent	`--`
`HUP`	Indicates the dialog was ended by hanging up	SS Intent
`globalResult`	Indicates the successful or not result of the miniApp. Potential values success/fail	success
`endType`	The session ending value	NEAR_HUP
`billable`	Indicates that this session was billed	true
`REPEAT_REQUEST`	Indicates a repeat request was triggered	`--`
`intelliAction_initialWait`	Indicates the initial wait prompt was triggered	`--`
`intelliAction_additionalWait`	Indicates the additional wait prompt was triggered	`--`
`AGENT_REQUEST`	Indicates an agent request was triggered	`--`
`validationResult`	Stores the result value of the miniApp validation	success
`validationFailName`	Stores the name value of the miniApp failed validation	myValidation
`validationFailReason`	Indicates the failed validation of the exact miniApp	patternFailed
`fail and FailExitReason`	Indicates the miniApp failed and the reason for the session ending	fail:MaxDisconfirmations
`AnnouncementMsg`	Indicates the system action of an Announcement miniApp prompts announcements of which were triggered	`--`
`AgentRequest_msg`	Indicates the error exit message for max agent requests was triggered	`--`
`Hold_NotEnabled:InformationAsked`
`Hold_MaxWait:InformationAsked`	Indicates the system action, which notifies the user that the timed out Hold functionality, was triggered	`--`
`GetIntent_Fail_HOLD:InformationAsked`	Indicates the triggered system action which asks the user if they want to use the Hold functionality after an invalid input	`--`
`Hold_Music`	Indicates that the system action which handles the ‘hold’ type requests was triggered	`--`
`ValidationFailed:InformationAsked`	Indicates that the system action which handles invalid inputs was triggered	`--`
`Hold_Escape:InformationAsked`	Indicates that the system action which handles DTMF inputs to stop the Hold functionality was triggered	`--`
`Get_Intent_DTMF_Response:InformationAsked`	Indicates that the system action which handles out of context DTMF inputs was triggered	`--`
`Get_Intent_New_Task:InformationAsked`	Indicates that the system action which handles the service of new tasks was triggered	`--`
`Conditional:InformationAsked`	Indicates that the system action which handles disambiguations without the Intent field used as a condition was triggered	`--`
`Intent_ReAsk:InformationAsked`	Indicates that the system action which handles re-ask type steps was triggered	`--`
`Ambiguous_Intent:InformationAsked`	Indicates that the system action which handles Intent disambiguations was triggered	`--`
`Conditional_Ambiguous_Intent:InformationAsked`	Indicates that the system action which handles Intent disambiguations was triggered	`--`
`Get_Intent_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Suggest_Intent`	Indicates that the system action which handles Intent confirmations was triggered	`--`
`GetEntity_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the Hold functionality after an invalid input was triggered	`--`
`Get_Entity_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Get_Entity:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Suggest_Entity:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`GetText_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Disconfirm_Text:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`Get_Text_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Suggest_Text:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`GetAlphanumeric_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Disconfirm_Alphanumeric:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`Get_Alphanumeric_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Get_Alphanumeric:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Confirm_Alphanumeric`	Indicates that the system action which confirms alphanumeric was triggered	`--`
`Suggest_Alphanumeric:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`CriticalError_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`MaxStartOvers_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`MaxDtmfInputs_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`MaxWrongInputs_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`MaxDisconfirmations_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`GlobalErrors_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`NoResponse_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`NoInterpretation_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`HoldOrTransfer`
`SuccessExit_msg`	Indicates that the exit message which notifies the caller that the system understood and collected the provided information was triggered.	`--`
`Closing_msg`	Indicates that the farewell exit message was triggered.	`--`
`InfoNotAvailable_msg`	Indicates that the relevant error message that activates on application exit was triggered	`--`
`DtmfEscape_msg`	Indicates that the DTMF escape functionality exit message was triggered	`--`
`Get_YesNo`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Get_YesNo_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`GetYesNo_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Suggest_Amount:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`Confirm_Amount:InformationAsked`	Indicates that the system action which asks a user if they want to confirm amount was triggered	`--`
`Get_Amount:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Get_Amount_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Disconfirm_Amount:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`GetAmount_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Suggest_Date:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`Confirm_Date:InformationAsked`	Indicates that the system action which confirm the date was triggered	`--`
`Get_Date:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Get_Date_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Disconfirm_Date:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`GetDate_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Suggest_Numeric:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`Confirm_Numeric:InformationAsked`	Indicates that the system action which confirms numeric was triggered	`--`
`Get_Numeric:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Get_Numeric_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Disconfirm_Numeric:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`GetNumeric_Fail_HOLD:InformationAsked`	Indicates that the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`Suggest_Alpha:InformationAsked`	Indicates that the system action which handles suggestions was triggered	`--`
`Confirm_Alpha`	Indicates that the system action which confirms alpha was triggered	`--`
`Get_Alpha:InformationAsked`	Indicates that the system action which acts as the initial prompt for requesting information was triggered	`--`
`Get_Alpha_StartOver:InformationAsked`	Indicates that the system action which handles start over requests was triggered	`--`
`Disconfirm_Alpha:InformationAsked`	Indicates that the system action which handles disconfirmations was triggered	`--`
`GetAlpha_Fail_HOLD:InformationAsked`	Indicates the system action which asks the user if they want to use the hold functionality after an invalid input was triggered	`--`
`HUP:Intent`	Indicates the system hung up with an Intent understood	`--`
`HUP:SS Intent`	Indicates the system hung up with an Intent self-served	`--`
`HUP:Information not available`	Indicates the system hung up due to the user not having the requested information	`--`
`HUP:No interpretation`	Indicates the system hung up due to reaching max no interpretations error threshold	`--`
`HUP:No response`	Indicates the system hung up due to reaching max no responses error threshold	`--`
`HUP:Max invalid inputs`	Indicates the system hung up due to reaching max no invalid inputs error threshold	`--`
`HUP:Mixed errors`	Indicates the system hung up due to reaching max mixed errors threshold	`--`
`HUP:Max disconfirmations`	Indicates the system hung up due to reaching max disconfirmations error threshold	`--`
`HUP:Max dtmf inputs`	Indicates the system hung up due to reaching max DTMF inputs threshold	`--`
`HUP:Max start overs`	Indicates the system hung up due to reaching max start over requests threshold	`--`
`HUP:BackEnd action error`	Indicates the system hung up due to a back end system error	`--`
`HUP:Critical error`	Indicates the system hung up due to a critical system error	`--`