onChatRequested()

Registers a function to call when an agent receives a chat request. Available in API version 29.0 or later.

NameTypeDescription
eventHandlerfunctionJavaScript method called when a chat request is assigned to an agent.

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

NameTypeDescription
chatKeyStringThe chat key for the incoming chat request.
successBooleantrue if firing event was successful; false if firing event wasn’t successful.