Configure onArticleCreate, onArticleUpdate, and onArticleDelete

When an agent creates an article and saves or publishes it in the knowledge base of the Freshworks system, the onArticleCreate event is triggered.

Subscribe to the onArticleCreate event and register the callback by using the following sample manifest.json content.

"events": {
  "onArticleCreate": {
      "handler": "onArticleCreateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

exports = {
  onArticleCreateCallback: function(payload) {
      console.log("Logging arguments from onArticleCreate event: " + JSON.stringify(payload));
  }
}

When an agent updates or modifies the knowledge base article created in the Freshworks system, the onArticleUpdate event is triggered. An article can be updated only if the first draft is already saved in the Freshworks system or if a published draft is unpublished and further modified for corrections before republishing.

Modifications to the following fields of the article triggers the onArticleUpdate event:

• Title
• Content
• Article Properties
  • Author
  • Folder
  • Tags
  • Title for Search Engine Optimization
  • Description for Search Engine Optimization

Subscribe to the onArticleUpdate event and register the callback by using the following sample manifest.json content.

"events": {
  "onArticleUpdate": {
    "handler": "onArticleUpdateCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

exports = {
  onArticleUpdateCallback: function(payload) {
    console.log("Logging arguments from onArticleUpdate event: " + JSON.stringify(payload));
  }
}

When an article is deleted from the knowledge base of the Freshworks system, the onArticleDelete event is triggered. This event is triggered only when an article saved as a draft in the Freshworks system is deleted or when a folder or category under which an article is saved is deleted.

The Freshworks system does not allow an agent to delete a published article; it has to be unpublished before deletion.

Subscribe to the onArticleDelete event and register the callback by using the following sample manifest.json content.

"events": {
  "onArticleDelete": {
    "handler": "onArticleDeleteCallback"
  }
}

Define the corresponding callback by using the following sample server.js content:

exports = {
  onArticleDeleteCallback: function(payload) {
    console.log("Logging arguments from onArticleDelete event: " + JSON.stringify(payload));
  }
}