To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Funnel trigger that fires on elearning module progress events, optionally filtered by website and by program, course or module code. Configured as JSON with type name "moduleTrigger" on a funnel automation. When a ModuleProgressEvent occurs, this trigger checks the event's action against the configured action (for example module completion), the event's website against websiteName, and, where set, the module status's program, course and module codes against the corresponding configured filters.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| action | String | Name of the ModuleProgressAction (such as a module completion) that the event must carry for this trigger to match. |
| courseCode | String | Course code that the event's module status must match for this trigger to match. |
| description | String | Human readable summary of this trigger's configuration, showing the website, program, course and module codes it is configured with. |
| fields | List<Pair<ExtraField,Object>> | Describes the editable fields of this trigger and their current values, used to render the trigger's edit form in the funnel automation admin UI. |
| funnelTriggerTypeId | String | The type identifier for this trigger, used to match it to its registered ModuleFunnelTriggerType and to tag its JSON representation. |
| moduleCode | String | Module code that the event's module status must match for this trigger to match. |
| programCode | String | Program code that the event's module status must match for this trigger to match. |
| websiteName | String | Name of the website the elearning event must belong to for this trigger to match. |
Methods
getFunnelTriggerTypeId()
Returns: String
The type identifier for this trigger, used to match it to its registered ModuleFunnelTriggerType and to tag its JSON representation.
getFields()
Returns: List<Pair<ExtraField,Object>>
Describes the editable fields of this trigger and their current values, used to render the trigger's edit form in the funnel automation admin UI.
getDescription()
Returns: String
Human readable summary of this trigger's configuration, showing the website, program, course and module codes it is configured with.
getWebsiteName()
Returns: String
Name of the website the elearning event must belong to for this trigger to match.
getProgramCode()
Returns: String
Program code that the event's module status must match for this trigger to match.
getCourseCode()
Returns: String
Course code that the event's module status must match for this trigger to match.
getModuleCode()
Returns: String
Module code that the event's module status must match for this trigger to match.
getAction()
Returns: String
Name of the ModuleProgressAction (such as a module completion) that the event must carry for this trigger to match.
© 2025 Kademi Ltd