Freshworks Developer Docs | Use events method

Front-end events are actions on the product UI, such as button clicks and changes/updates to the UI field values. Events method is an interface that the developer platform provides, to enable your app to react to front-end events.

To enable your app to react to front-end events, in the app.js file,

Subscribe to the app.initialized event, through an event listener. When the app is initialized, the parent application passes a client reference to the app.
After app initialization,
1. Use the client reference, subscribe to <Event name> and register a callback method to be executed when the event occurs.
2. Define the callback method.

When the event occurs, a payload is passed to the callback method. Let us call this payload event. event.type returns the name of the event. The event.helper.getData() helper method returns a JSON object that contains information pertaining to the event. Your app logic can process this data into meaningful results.

Front-end events are of the following types: Click events, Change events, Intercept events.

Currently, for this module, only Change events and one click event (calling) are supported.

Change events

These events occur when a user changes the value of a field on the UI.

Note:User need not submit the modified value for the event listeners to pick up the event and execute the callback; merely changing the values is sufficient for the event trigger.

The event.helper.getData() method returns a JSON that contains the old and new values of the changed field.

Intercept events

These are events that are paused, while the event listener and the corresponding callback run. The app can choose to allow the original event to complete or block the event.

To enable your app to intercept an event, after app initialization,

Use the client reference, subscribe to event, register a callback method to be executed when the event occurs, and set intercept as true.
Define the callback method.
To allow the event to proceed, use the event.helper.done() helper method.
To prevent the event from completion, use the event.helper.fail(‘errorMessage’) helper method.
To obtain data pertaining to the event, use the event.helper.getData() helper method. If your app is intercepting a click event, the method returns an empty JSON.

SAMPLE APP.JS

  /*Configure event listener, register callback, set intercept to true*/
client.events.on("chatConversation.onSendMessage", eventCallback, {intercept: true});
  /*Define callback*/
var eventCallback = function (event) {
  console.log(event.type + " event occurred");
    /*Obtain data for event*/
  var event_data = event.helper.getData();
    /*Insert your app logic
    As part of app logic, allow the original event to continue*/
  event.helper.done();
    /*As part of app logic, prevent the original event from completing*/
  event.helper.fail(‘errorMessage’);
};

Common event

If your app is built to be deployed on the left_nav_cti placeholder, the app can react to the calling event when the corresponding event trigger occurs.

Event name	Event trigger
calling	When a user clicks the call icon or phone number link that is displayed on any of the following pages of the product UI: Contact list page > Contact hover card > Make call widget Contact list page > Work phone field Contact details page > Work phone and Mobile fields Contact details page > Make call widget

calling

Use the sample code shown on the right pane > Sample code tab, to enable your app to react to user clicks such as the click on a call icon or phone number, on the UI.

Sample code

Sample payload

{
  //Configure event listener and subscribe to event
  //Register callback
  client.events.on("calling", eventCallback);
  var eventCallback = function (event) {
  //Retrieve event data
  var data = event.helper.getData();
  // App logic
  };
}

Contact details page events

Event name	Event trigger
contact.update	When a user updates a contact.

Conversation editor page events

Event name	Event trigger
Intercept events
chatConversation.onSendMessage	When an agent clicks the Send button. The event payload is the chatConversation.onSendMessage object.
Change events
chatConversation.propertiesLoaded	When an agent, collapses and then reopens the conversation properties widget. navigates from one conversation to another. updates values within the conversation properties widget.

Event descriptions

contact.update

Use the sample code shown on the right pane > Sample code tab, to enable your app to react when a user updates a contact.

Sample code

{
    //Configure event listener and subscribe to event
    //Register callback
  client.events.on("contact.update", eventCallback);
  var eventCallback = function (event) {
    //Retrieve event data
  var data = event.helper.getData();
    // App logic
  };
}

chatConversation.onSendMessage

Use the sample code shown on the right pane > Sample code tab, to enable your app to respond when an agent clicks the Send button in either the conversation reply editor or email editor.

Note:The chatConversation.onSendMessage method triggers only when the Send button is clicked in reply editors for conversations and emails; it does not trigger for new email conversation creation.

Sample code

Sample payload

{
  //Configure event listener and subscribe to event
  //Register callback
  client.events.on("chatConversation.onSendMessage", eventCallback, {intercept: true});
  var eventCallback = function (event) {
  //Retrieve event data
  var data = event.helper.getData();
  // App logic
  };
}

chatConversation.propertiesLoaded

Important:This event is not supported for a stand-alone Freshsales Classic subscription account.

Use the sample code shown on the right pane > Sample code tab, to enable your app to react when an agent,

collapses and then reopens the conversation properties widget.
navigates from one conversation to another.
updates values within the conversation properties widget.

Sample code

Payload

{
  //Configure event listener and subscribe to event
  //Register callback
  client.events.on("chatConversation.propertiesLoaded", eventCallback);
  var eventCallback = function (event) {
  //Retrieve event data
  var data = event.helper.getData();
  // App logic
  };
}

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Use events method

Common event

calling

Contact details page events

Conversation editor page events

Event descriptions

contact.update

chatConversation.onSendMessage

chatConversation.propertiesLoaded

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Use events methodOn this page

Common event

calling

Contact details page events

Conversation editor page events

Event descriptions

contact.update

chatConversation.onSendMessage

chatConversation.propertiesLoaded

Use events method