Custom API action scripts allow you to execute a Studio script from an external application using the CXone API. They are special Studio scripts that are saved as Studio Framework actions and are accessible with REST API endpoints.
They allow you to:
- Pass data back to the calling script or application.
- Be called from outside CXone when using them as REST APIs.
Custom API action scripts must be created with the API action script type. This type must be enabled on your business unit
High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment. If it's not available in Studio, contact your Account Representative. Scripts created with the API action type start out with a template of a basic API script. They contain the essential actions and flow to define a set of conditions and the data to be returned. You can modify the script to meet your organization's needs, within the limitations of this script type.
Limitations
Custom API action scripts are an advanced Studio feature. They require advanced Studio scripting skills, as well as an understanding of REST APIs and how to work with them.
API action scripts support a small subset of Studio actions. There are many actions that do not work in this type of script. If you add an action to a script and receive the following error, the action is not supported: Warning! The action you are adding to the active script is currently unsupported in the context of an API Action script. Many of the basic Studio actions are supported. However, a list of supported actions is not currently available.
Do thorough testing with your API action script to ensure that it works as intended. This includes testing the API action script itself and testing of any script in which you use your custom API action.