Funnel automation trigger that fires when a recognition award (such as a badge or level) matching a configured recognition name and topic is granted, optionally scoped to organisations or profiles only. Both recognitionName and recognitionTopic must be set for this trigger to ever match. It fires once per award, so it can fire several times in one recalculation when several levels are passed through in succession; RecognitionLevelAchievedFunnelTrigger fires only once, for the level the participant settled on. Registered under the trigger type id "recognitionTrigger" via RecognitionFunnelTriggerType, and evaluated against RecognitionEvent events.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this trigger's configuration, combining the configured recognition name, topic and whether it applies to organisations or profiles. |
| fields | List<Pair<ExtraField,Object>> | The editable fields for this trigger's configuration (recognition name, topic and orgOnly), used to render the trigger's settings form in the journey automation editor. |
| funnelTriggerTypeId | String | The trigger type id this trigger is registered under, used to look up its RecognitionFunnelTriggerType. |
| orgOnly | Boolean | Whether this trigger applies to organisation-level recognition events (true) or profile-level events (false or null). |
| recognitionName | String | Name of the recognition (eg a badge or level) that must be awarded for this trigger to match. Required for the trigger to ever match. |
| recognitionTopic | String | Name of the recognition topic this trigger applies to. Required for the trigger to ever match. |
Methods
getFunnelTriggerTypeId()
Returns: String
The trigger type id this trigger is registered under, used to look up its RecognitionFunnelTriggerType.
getFields()
Returns: List<Pair<ExtraField,Object>>
The editable fields for this trigger's configuration (recognition name, topic and orgOnly), used to render the trigger's settings form in the journey automation editor.
getDescription()
Returns: String
Human-readable summary of this trigger's configuration, combining the configured recognition name, topic and whether it applies to organisations or profiles.
getRecognitionName()
Returns: String
Name of the recognition (eg a badge or level) that must be awarded for this trigger to match. Required for the trigger to ever match.
getRecognitionTopic()
Returns: String
Name of the recognition topic this trigger applies to. Required for the trigger to ever match.
getOrgOnly()
Returns: Boolean
Whether this trigger applies to organisation-level recognition events (true) or profile-level events (false or null).