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.

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.

Important

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 Widgets Extensions for more information about extending Genesys Widgets.

var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('CallbackService.ready', function(e){});

Name	Description	Data
ready	CallbackService is initialized and ready to accept commands.	n/a
scheduled	Callback is scheduled successfully.	200 OK AJAX Response - Schedule Callback For Callback API v3, refer to 'Responses' in Schedule Callback V3
scheduleError	An error occurred between the client and the server during a callback schedule.	The JSON data returned by GMS Callback server. For Callback API v3, refer to 'Responses' in Schedule Callback V3
availableSlots	Callback available slots fetched successfully.	200 OK AJAX Response - Query Callback Availability For Callback API v3, refer to 'Responses' in Availability Callback V3
availabilityError	An error occurred between the client and the server while fetching the available timeslots.	The JSON data returned by GMS Callback server. For Callback API v3, refer to 'Responses' in Availability Callback V3