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

A calendar with a checkmark in it.

Creates a custom event through which you can deliver unique data.


This action is found on the API Actions palette.

Supported Script Types

A square with a line branching from it that goes to three other squares.


Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.



Add Caption

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

Target Agent

Target agent ID.

Event Name

Enter the name you for the custom event. Multiple events with the same name overwrite each other. Only the most recent event name is kept. This field is case-sensitive.


Controls whether or not CXone keeps the event in memory.


Data payload for this event.

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.
OnAgentNotConnected Path taken if the destination agent is not connected.