Jump to: navigation, search

eventName.VisitStarted

Section: userData
Default Value: timezoneOffset
Valid Values: Comma-separated list of fields expected in data object of VisitStarted event.
Changes Take Effect: Immediately


A comma-separated list of fields from the data object of a VisitStarted event. The value of these fields will be added to the User Data of the webengagement Open Media interaction prior to submitting it into the Interaction Queue.

Starting with release 8.5.100.13, the following patterns are supported:

* to describe "all keys"
prefix_* to describe "all keys starting with prefix_"
*_suffix to describe "all keys ending in _suffix"

eventName.UserInfo

Section: userData
Default Value:
Valid Values: Comma-separated list of fields expected in data object of UserInfo event.
Changes Take Effect: Immediately


A comma-separated list of fields from the data object of a UserInfo event that belongs to the current session. The value of these fields will be added to the User Data of the webengagement Open Media interaction prior to submitting it into the Interaction Queue.

Starting with release 8.5.100.13, the following patterns are supported:

* to describe "all keys"
prefix_* to describe "all keys starting with prefix_"
*_suffix to describe "all keys ending in _suffix"

eventName.SignIn

Section: userData
Default Value:
Valid Values: Comma-separated list of fields expected in data object of SignIn event.
Changes Take Effect: Immediately


A comma-separated list of fields from the data object of a SignIn event that belongs to the current session. The value of these fields will be added to the User Data of the webengagement Open Media interaction prior to submitting it into the Interaction Queue.

Starting with release 8.5.100.13, the following patterns are supported:

* to describe "all keys"
prefix_* to describe "all keys starting with prefix_"
*_suffix to describe "all keys ending in _suffix"

eventType.ACTIONABLE

Section: userData
Default Value: rule
Valid Values: A comma-separated list of fields expected in the data object of an ACTIONABLE event.
Changes Take Effect: Immediately


A comma-separated list of fields expected in the data object of an ACTIONABLE event. The value of these fields will be added to the User Data of the webengagement Open Media interaction prior to submitting it into the Interaction Queue.

Starting with release 8.5.100.13, the following patterns are supported:

* to describe "all keys"
prefix_* to describe "all keys starting with prefix_"
*_suffix to describe "all keys ending in _suffix"

keysToPropagate

Section: userData
Default Value:
Valid Values: Comma-separated list of fields expected in the data object of an ACTIONABLE event.
Changes Take Effect: Immediately


A comma-separated list of keys. The specified keys will be copied from the data object of ACTIONABLE event into the userData object of notification message and later attached as UserData of the chat interaction.

Starting with release 8.5.100.13, the following patterns are supported:

* to describe "all keys"
prefix_* to describe "all keys starting with prefix_"
*_suffix to describe "all keys ending in _suffix"

userData Section

Click on an option to view its properties:

keysToPropagate

eventType.ACTIONABLE

eventName.SignIn

eventName.UserInfo

eventName.VisitStarted

This page was last edited on May 31, 2019, at 16:45.
Comments or questions about this documentation? Contact us for support!