Jump to: navigation, search
(Automated save: adding PEC_Migrated template.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
= API Events =
 
= API Events =
Once you've registered your own plugin on the bus, you can subscribe and listen for published events. Below we'll quickly register a new plugin on the bus using the global bus object.
 
  
{{NoteFormat|The global bus object is a debug tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see [[GWCBusExtensions|Widgets Extensions]] for more information about extending Genesys Widgets.|1}}
+
{{Template:PEC_Migrated}}
  
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
 
  
oMyPlugin.subscribe('Callback.ready', function(e){});</source>
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Callback-combined#API_Events.}}
 
 
{|
 
|-
 
! Name
 
! Description
 
! Data
 
|-
 
| opened
 
| The Callback widget has appeared on screen.
 
| [[CallbackMetadata|metadata]]
 
|-
 
| ready
 
| Callback is initialized and ready to accept commands.
 
| n/a
 
|-
 
| started
 
| When the user has started filling out the Callback widget form or auto pre-filled it.
 
| [[CallbackMetadata|metadata]]
 
|-
 
| submitted
 
| When the user has submitted the form.
 
| [[CallbackMetadata|metadata]]
 
|-
 
| completed
 
| When the Callback widget form is submitted successfully.
 
| [[CallbackMetadata|metadata]]
 
|-
 
| cancelled
 
| When the user has abandoned the interaction by closing the Callback widget before scheduling a callback.
 
| [[CallbackMetadata|metadata]]
 
|-
 
| closed
 
| The Callback widget has been removed from the screen.
 
| [[CallbackMetadata|metadata]]
 
|-
 
|}
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 22:35, June 21, 2020

API Events

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Callback-combined#API_Events.
This page was last edited on June 21, 2020, at 22:35.
Comments or questions about this documentation? Contact us for support!