Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CxCallBody

The body of each dispatchCXEvent call

Hierarchy

  • CxCallBody

Index

Constructors

Properties

Constructors

constructor

Properties

authentication_flag

authentication_flag: boolean = null

If the user is authenticated. Flagging "True" indicates that a consumer ID is available.

Optional consumer_id

consumer_id: string | number

Consumer ID - such as member ID, agent ID, etc.

Optional consumer_recommendation_id

consumer_recommendation_id: string | number

The consumer recommendation ID to be updated by this event

Optional context

context: CxContext

This contains additional information relevant to the request.

Optional dictionary_attributes

dictionary_attributes: any

Contains a list of data keys that can be used as additional parameters for the event

name

name: string = null

Event Name

Optional session_id

session_id: string | number

Contains a user's session ID if browsing an online application

source_system_name

source_system_name: string = null

Source System Names must be unique and configured for capture. This value will be provided to you by a Zipari analyst.

Optional transaction_id

transaction_id: string | number

Payer-configurable transaction ID, used for tracking data throughout the system.