onChatRequested()

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

Syntax

Name	Type	Description
eventHandler	function	JavaScript 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:

Name	Type	Description
chatKey	String	The chat key for the incoming chat request.
success	Boolean	`true` if firing event was successful; `false` if firing event wasn’t successful.