This help page is for Desktop Studio. This information is also available for CXone Studio.

Content on this page is for a product or feature in controlled release (CR). If you are not part of the CR group and would like more information, contact your CXone Account Representative.

Executes an Integration Hub request. If the connection you use with this action includes secrets, you can use them in a script that contains this action.

Double-clicking this action opens Integration Hub where you can configure the connection integration you want this action to use.


  • This action requires Integration Hub.
  • This action is commonly used with the ConnectAuth action.
  • Each instance of this action in a script can execute one connection. Open Integration Hub and click the selection icon An icon of a circle with a  checkmark in it. to assign the connection you want to this action.

  • For Studio requests, the requestPayload property must be populated with a dynamic object that contains details about the request, including the URL, headers, verb, parameters, secrets, and so on. The contents must be in JSON format. Use a Snippet action to create the dynamic object and its members and to convert it to JSON.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.


Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.




Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

connectName Defines the specific connection to use with this action. You can double-click this action to assign a connection from Integration Hub.
requestName Defines the specific request configured in the specified connector to run with this action. You can double-click this action to assign a request from Integration Hub.
requestPayload Enter the payload for the specified request in JSON format. You can use a Snippet action to convert the request to JSON.

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.



requestBodyVarName (out) Holds the request body. The default is requestBody.
requestErrorDetailsVarName (out) Holds the error details, in the event of an error with the request. The default is requestErrorDetails.
requestHeadersListVarName (out) Holds the list of request headers. The default is requestHeadersList.
requestProxyVarName (out) Holds the request proxy. The default is requestProxy.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.



Default Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

The path taken when the action doesn't execute properly. For example, when there's an unexpected problem, such as syntax errors, HTTP error codes, and so on. The ERR variable should be populated with a condensed explanation of the problem.


Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).


The path taken if there's no response from the request for the number of milliseconds defined in the request configuration in Integration Hub.