Interface WellnessBreakEvent

Validated, agent-scoped wellness notification emitted by Contact Center.

interface WellnessBreakEvent {
    actionEvent: WellnessBreakNotificationAction;
    actionText?: string;
    agentId: string;
    agentSessionId: string;
    interactionId?: string;
    orgId: string;
    trackingId?: string;
}

Properties

actionEvent actionText? agentId agentSessionId interactionId? orgId trackingId?

Properties

actionEvent

actionEvent: WellnessBreakNotificationAction

Backend wellness action

Optional actionText

actionText?: string

Optional untrusted plain-text message supplied by the backend

agentId

agentId: string

Agent identifier

agentSessionId

agentSessionId: string

Session identifier supplied by the notification; it may differ from the consumer's active session

Optional interactionId

interactionId?: string

Optional normalized interaction diagnostic

orgId

orgId: string

Organization identifier

Optional trackingId

trackingId?: string

Notification diagnostic only; never an action-request correlation identifier

Settings

Member Visibility

Theme

On This Page

actionEventactionTextagentIdagentSessionIdinteractionIdorgIdtrackingId