ConnectAuth

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.

Allows you to use authentication details configured in a connection in Integration Hub.

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

Dependencies

  • This action requires Integration Hub.
  • This action is commonly used with the ConnectRequest action.
  • Each instance of this action in a script can authenticate 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.
  • This action requires an integration connection configured with authentication. You can create one in Integration Hub.

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.

Generic

 Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

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. The connection must be configured with authentication details. You can double-click this action to assign a connector from Integration Hub.

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.

Property

Description
authBodyVarName (out) Holds the authorization body for the request. The default is authBody.
authErrorDetailsVarName (out) Holds the error details for the request, in the event of an error. The default is authErrorDetails.
authHeadersListVarName (out) Holds the list of authorization headers. The default is authHeadersList.
authProxyVarName (out) Holds the authorization proxy. The default is authProxy.

Result Branch Conditions

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

Condition

Description
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.
OnSuccess

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

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.

OnTimeout

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