Use the following built-in functions to log events and print debug messages.

New to scripting functions? Please review the Introduction.

Log custom event

Used for tracking specific bot events for the purposes of analytics. This function requires some type of user message and event name. The event detail is optional. In the example, we are setting the user message to the currentUserMessage and naming the event “Invoice API”.

Function Name Arguments Returns
logCustomEvent(user_message, event_name, event_detail) user_message - the user's message text

event_name - string

event _detail - string; any optional detail


botContext.logCustomEvent(botContext.getCurrentUserMessage(), 'Invoice API', 'API call successful');

For a step-by-step, example guide on implementing custom event logging, see here.

To view the details of a custom event, in Bot Analytics you must click Download Event Details (not Download) and examine the downloaded CSV file.

Log escalation event

Used to count the number of times the user called a particular escalation type. The function requries a user input and the string 'LivePerson' for the type of escalation.

Function Name Arguments Returns
logEscalationEvent(user_message, escalation_type) user_message - the user's message text

escalation_type - 'LivePerson'


botContext.logEscalationEvent(botContext.getCurrentUserMessage(), 'LivePerson');

The Print Debug Message is used to log what user said in the debug console of the bot. For instance, the response variable stores the most recent messages from the user, which we print to the debugger using printDebugMessage.

Function Name Arguments Returns
printDebugMessage(message) message (string) – A message to print to the debug logs. None


// get what the user just said
var response = botContext.getCurrentUserMessage();
botContext.printDebugMessage('User said ' + response);