Automation trigger which fires when a participant gets close to (but has not yet reached) a recognition level. Matches the RecognitionCloseToLevelEvent.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this trigger's configuration, combining the configured level name, recognition topic and whether it applies to organisations or profiles. |
| fields | List<Pair<ExtraField,Object>> | The editable fields for this trigger's configuration (recognition topic, level name 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 RecognitionCloseToLevelFunnelTriggerType. |
| 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 level a participant must be approaching for this trigger to match. Blank matches any level in the configured topic. |
| 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 RecognitionCloseToLevelFunnelTriggerType.
getFields()
Returns: List<Pair<ExtraField,Object>>
The editable fields for this trigger's configuration (recognition topic, level name 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 level name, recognition topic and whether it applies to organisations or profiles.
getRecognitionName()
Returns: String
Name of the recognition level a participant must be approaching for this trigger to match. Blank matches any level in the configured topic.
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).