Deflection Signal

lightningcommunity:deflectionSignal

Indicates that a Experience Builder site user interacts with a deflection item (an item determined to be responsible for a case deflection). Reports can then be created on supported signal types.

For Use In

Experience Builder Sites

The lightningcommunity:deflectionSignal event is fired whenever a site user interacts with a deflection item. Reports can then be created on supported signal types.

Custom Aura components can listen to this system event and handle it as required, for example, to kickstart another process if the user did not find an article helpful.

This client-side controller example handles the system event and checks for an interaction where the user did not find the deflection item helpful.

A lightningcommunity:deflectionSignal event is fired when a user is going through a process to solve an issue, and then interacts with a deflection item that could potentially resolve their issue early. For example, a lightningcommunity:deflectionSignal event is fired by the Case Deflection component with information about the user’s interaction with a helpful Article.

Generally, a deflection has two parts:

the source: some process or record the user starts on, such as the case create form
the destination: a deflection item that the user then interacts with, such as a useful article The sourceType determines how the event gets processed. Only events with a supported sourceType are processed for Custom Report Types. Currently, the only supported value for sourceType is caseCreateDeflectionModal.

The content of the payload attribute depends on the type of signal used.

This event is handled by the one.app container. It’s supported in Aura-based Experience Builder sites.

For more information about this event, see the Experience Cloud Developer Guide.

Name	Description	Type	Default
`callback`	Callback function invoked after signal is received and processed. Only called if `shouldSubmitSourceTypeSignals=true`.	object
`destination`	The ID of the deflection item.	string
`destinationType`	Object type of the deflection item.	string
`payload`	Additional information about the deflection signal. The content of the payload depends on the sourceType.	object
`shouldSubmitSourceTypeSignals`	Once an event is fired with `shouldSubmitSourceTypeSignals=true`, all signals of that `sourceType` are submitted to the server in a single batch to be processed. This should always be true unless signals are logically dependent on each other and must be processed together.	boolean	true
`source`	The unique identifier of how the user arrived at the deflection item	string
`sourceType`	Descriptor of where deflection occured. Only signals with supported types will get processed. `sourceType` is synonymous with signalAgent.	string