Configure product events

Product events are events such as ticket creation, ticket updation, conversation creation, and so on, that occur in the product on which your app is deployed. You can enable product events to trigger your app, call a corresponding callback function, and execute the app logic.

To do this,

1. From your app’s root directory, navigate to the manifest.json file.

2. Subscribe to an event by configuring an event listener: Include the events attribute under modules.<module_name>, specifying the product-event's name and the corresponding callback methods as follows:

   manifest.json

    "events": {
      "<productEventName>": {
          "handler": "<eventCallbackMethod>"
      }
    }

   When the event occurs, the corresponding event listener invokes the callback method and passes a standard payload to the method.

3. Navigate to the server.js file. In the exports block, enter the callback function definition as follows:

   Sample server.js

    exports = {
      // args is a JSON block containing the payload information
      // args["iparam"] will contain the installation parameter values
      //eventCallbackMethod is the call-back function name specified in manifest.json
      eventCallbackMethod: function(args) {
        console.log("Logging arguments from the event: " + JSON.stringify(payload));
      }};

When building a common module app, you must specify at least one other module in the app manifest. The other module(s) specified determine the product where the common module app is deployed. An app built for the common module can react to product-specific events associated with the other module(s) that are included in the app manifest.

To know more about these events,

1. In the left navigation pane of this document, from the Module drop-down box, select the module that you intend to use along with the common module. The documentation corresponding to the selected module is displayed.
2. From the left-navigation pane, navigate to the Serverless apps > Product events topic.

When a product event occurs, an event-specific payload is passed to the callback method.

The payload is a JSON object with the following attributes.