ATC/Current/SDK/Use Events methods with web actions - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

2021-11-09T21:27:47Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

2021-08-10T10:35:30Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:29:11Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T19:11:29Z

Published

Barbara.martin@genesys.com: Published

2020-12-15T13:21:11Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:30:03Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

2020-07-15T11:59:36Z

Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:46:25Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

2020-06-10T10:11:44Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Use Events methods with web actions
|TocName=Use Events methods with web actions
|Context=Use Events methods to subscribe to events that occur during the lifecycle of {{MINTYDOCSPRODUCT}} web actions such as {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|display text=web chats}} and {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_content_offers|display text=content offers}}. This raw data can be streamed to third-party analytics platforms or to tag management platform data layers for use in analytics and reporting platforms.
|Dimension=WebActions
|ComingSoon=No
|Platform=PureEngage, PureConnect, PureCloud
|Prereq=
|Section={{Section
|sectionHeading=Event methods for web actions
|anchor=WebActionMethods
|alignment=Vertical
|Media=
|image=
|structuredtext=To capture information about events that occur during the lifecycle of a web action, use the Events methods shown in the following table.
{{{!}} class="wikitable"
{{!}}+
!Method
!Description
{{!}}-
{{!}}
{{Link-SomewhereInThisVersion|manual=SDK|topic=on|display text=on}}
{{!}}
Subscribe to start receiving {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=events}} for a given type of web action in a given {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=Examples|display text=state}}.
{{!}}-
{{!}}
{{Link-SomewhereInThisVersion|manual=SDK|topic=once|display text=once}}
{{!}}
Receive {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=events}} for only the first occurrence of a given type of web action in a given {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=Examples|display text=state}}.
{{!}}-
{{!}}
{{Link-SomewhereInThisVersion|manual=SDK|topic=off}}
{{!}}
Unsubscribe to stop receiving {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=events}} for a given type of web action in a given {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=Examples|display text=state}}.
{{!}}}
<br />
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Media types, lifecycle states, and code examples using Events methods
|anchor=WebActionMediaTypes
|alignment=Vertical
|Media=
|image=
|structuredtext=<br />
{{{!}} class="wikitable"
{{!}}+
!Media type
!Lifecycle states
!Code examples
{{!}}-
{{!}}contentoffer
{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle}}
{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_content_offers}}
{{!}}-
{{!}}webchat
{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=Web_chat_lifecycle}}
{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_chats}}
{{!}}}
<br />
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Event types for web actions
|anchor=EventsWebActions
|alignment=Vertical
|Media=
|image=
|structuredtext=The following table lists the events that you can use with {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=WebActionMethods|display text=Events methods for web actions}}. Event information returned includes the action state, customer ID, session ID, and action map ID.
{{{!}} class="wikitable"
{{!}}+
!Event
!Data type
!Description
{{!}}-
{{!}}actionId
{{!}}UUIDv4
{{!}}Unique Id for a specific Predictive Engagement action.
{{!}}-
{{!}}actionState
{{!}}String
{{!}}Current state of the action. For example, offered.
{{!}}-
{{!}}actionMediaType
{{!}}String
{{!}}The engagement type. For example, webchat.
{{!}}-
{{!}}actionMapId
{{!}}UUIDv4
{{!}}Id of the action map that qualified/triggered this action.
{{!}}-
{{!}}actionMapVersion
{{!}}Integer
{{!}}Version of the action map.
{{!}}-
{{!}}customerId
{{!}}UUIDv4
{{!}}Stable identifier of the customer. For example, a cookie Id.
{{!}}-
{{!}}customerIdType
{{!}}String
{{!}}The specific type of customer identifier (always "cookie").
{{!}}-
{{!}}sessionId
{{!}}UUIDv4
{{!}}Identifier of the customer's current web session.
{{!}}-
{{!}}errorCode
{{!}}Integer
{{!}}Status code for any exceptions caught during presentation of the action.
{{!}}-
{{!}}errorMessage
{{!}}String
{{!}}Error message for any exceptions caught during presentation of the action.
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Capture more data with Genesys widgets
|anchor=CaptureMore
|alignment=Vertical
|Media=
|image=
|structuredtext=The Web Action Events API can be used with Genesys Widgets commands to enrich events with more data that may be useful.

For example, the Genesys Cloud <code>conversationId</code> may be useful in an analytics context. For more information on the Widgets API, see [https://docs.genesys.com/Documentation/GWC/Current/WidgetsAPI/WebChatServiceCommands API Commands].<syntaxhighlight lang="javascript">
ac('on', 'webchat:all', (evt) => {
_genesys.widgets.bus.command('WebChatService.getSessionData').then((data) => {
if (data.conversationId) {
evt.conversationId = data.conversationId;
}

someAnalyticsProvider.send(evt);
})
});
</syntaxhighlight>{{NoteFormat|The data returned by WebChatService.getSessionData will differ based on your Genesys platform.}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 9: / Line 9: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
+|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 |Status=No
 }}{{Section
@@ Line 117: / Line 117: @@
 |structuredtext=You can use the Web Action Events API with Genesys Widgets commands to enrich events with more data that may be useful.
-For example, the Genesys Cloud <code>conversationId</code> may be useful in an analytics context. For more information on the Widgets API, see [https://docs.genesys.com/Documentation/GWC/Current/WidgetsAPI/WebChatServiceCommands API Commands].<syntaxhighlight lang="javascript">
+For example, the Genesys Cloud CX <code>conversationId</code> may be useful in an analytics context. For more information on the Widgets API, see [https://docs.genesys.com/Documentation/GWC/Current/WidgetsAPI/WebChatServiceCommands API Commands].<syntaxhighlight lang="javascript">
 ac('on', 'webchat:all', (evt) => {
    _genesys.widgets.bus.command('WebChatService.getSessionData').then((data) => {

@@ Line 3: / Line 3: @@
 |DisplayName=Use Events methods with web actions
 |TocName=Use Events methods with web actions
-|Context=Use Events methods to subscribe to events that occur during the lifecycle of {{MINTYDOCSPRODUCT}} web actions such as {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|display text=web chats}} and {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_content_offers|display text=content offers}}.  This raw data can be streamed to third-party analytics platforms or to tag management platform data layers for use in analytics and reporting platforms.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
+|Context=Use Events methods to subscribe to events that occur during the lifecycle of {{MINTYDOCSPRODUCT}} web actions such as {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|display text=web chats}} and {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_content_offers|display text=content offers}}.  This raw data can be streamed to third-party analytics platforms or to tag management platform data layers for use in analytics and reporting platforms.
 |Dimension=WebActions
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Event methods for web actions
 |anchor=WebActionMethods

@@ Line 6: / Line 6: @@
 |Dimension=WebActions
 |ComingSoon=No
-|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Event methods for web actions
 |anchor=WebActionMethods
 |alignment=Vertical
 |structuredtext=To capture information about events that occur during the lifecycle of a web action, use the Events methods shown in the following table.
 {{{!}} class="wikitable"
@@ Line 36: / Line 39: @@
 {{!}}}
 <br />
 |Status=No
 }}{{Section
@@ Line 43: / Line 44: @@
 |anchor=WebActionMediaTypes
 |alignment=Vertical
 |structuredtext=<br />
 {{{!}} class="wikitable"
@@ Line 61: / Line 60: @@
 {{!}}}
 <br />
 |Status=No
 }}{{Section
@@ Line 68: / Line 65: @@
 |anchor=EventsWebActions
 |alignment=Vertical
 |structuredtext=The following table lists the events that you can use with {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=WebActionMethods|display text=Events methods for web actions}}. Event information returned includes the action state, customer ID, session ID, and action map ID.
 {{{!}} class="wikitable"
@@ Line 117: / Line 112: @@
 {{!}}Error message for any exceptions caught during presentation of the action.
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 124: / Line 117: @@
 |anchor=CaptureMore
 |alignment=Vertical
 |structuredtext=The Web Action Events API can be used with Genesys Widgets commands to enrich events with more data that may be useful.
@@ Line 139: / Line 130: @@
 });
 </syntaxhighlight>{{NoteFormat|The data returned by WebChatService.getSessionData will differ based on your Genesys platform.}}
 |Status=No
 }}
 }}

ATC/Current/SDK/Use Events methods with web actions - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"