Configure onAgentStatusCreate, onAgentStatusUpdate, and onAgentStatusDelete

The onAgentStatusCreate event is triggered and the registered callback method is executed, when a custom agent status is created in the Freshworks system.

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

"events": {
    "onAgentStatusCreate": {
         "handler": "onAgentStatusCreateCallback"
    }
}

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

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

The onAgentStatusUpdate event is triggered when there are modifications to the following attributes of an agent’s status:

• Status name
• Emoji (icon associated with the status)
• State

Note:Only an agent with admin level permissions can modify the state of a custom status.

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

"events": {
    "onAgentStatusUpdate": {
        "handler": "onAgentStatusUpdateCallback"
    }
}

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

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

The onAgentStatusDelete event is triggered when:

• An admin deletes the custom statuses configured in the Freshworks system.
• Account deletion or moving the account to a plan that does not support custom statuses causes the Freshworks system to automatically delete the custom statuses.

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

"events": {
    "onAgentStatusDelete": {
        "handler": "onAgentStatusDeleteCallback"
    }
}

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

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