The id for the object that triggered the help request.
The current route that the user is on when asking for help.
Will always be HELP_REQUEST_TYPE.
The help url for the specific integration.
The amount of time the integration has to respond to this message.
Will always be EVENT_OCCURRENCE_TYPE.
Generated using TypeDoc
A request that Ultra-UI will send to an integration when users ask for help.
An example request that Ultra-UI will send to the integration when asking help on the base course page:
{ type: 'event:event', eventType: 'help:request', correlationId: 'some-unique-id', helpUrl: 'http://help.blackboard.com/XXXXXXX', currentRouteName: 'base.courses' }