To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Runtime representation of a custom automation trigger type contributed by a marketplace app, built by FunnelTriggerTypeBuilder.build() when the app's controller mappings call addFunnelTriggerType. Wraps the app's title, description, the event id it listens for and the configuration fields, and the names of the JS functions that check whether an event's parameters match (checkMatchFn) and that can adjust the field list at render time (fieldsFunction).
Group: Journeys
Implements: FunnelTriggerType
Properties
| Property | Returns | Description |
|---|---|---|
| checkMatchFn | String | Name of the app JS function called to test whether a fired event's parameters match this trigger's configured parameters. May be blank, in which case every occurrence of the event id is treated as a match. |
| description | String | Explanatory text shown alongside the title in the automation editor's trigger picker, as declared by the app. |
| fieldsFn | String | Name of the app JS function called to adjust the configuration field list at render time, for example to populate option lists from current account data. May be blank if the fields are static. |
| id | String | Unique id of this trigger type, as declared by the app when it registered the trigger type. Matched against RepoAppFunnelTrigger.getTriggerTypeId() to resolve the type for a configured trigger. |
| itemIdField | String | Name of the field within a fired event's parameters that identifies the specific item the event relates to, used to record which item triggered an automation. May be blank if this trigger type does not identify items. |
| title | String | Display title of this trigger type shown in the automation editor's trigger picker, as declared by the app. |
Methods
getId()
Returns: String
Unique id of this trigger type, as declared by the app when it registered the trigger type. Matched against RepoAppFunnelTrigger.getTriggerTypeId() to resolve the type for a configured trigger.
getTitle()
Returns: String
Display title of this trigger type shown in the automation editor's trigger picker, as declared by the app.
getDescription()
Returns: String
Explanatory text shown alongside the title in the automation editor's trigger picker, as declared by the app.
getCheckMatchFn()
Returns: String
Name of the app JS function called to test whether a fired event's parameters match this trigger's configured parameters. May be blank, in which case every occurrence of the event id is treated as a match.
getFieldsFn()
Returns: String
Name of the app JS function called to adjust the configuration field list at render time, for example to populate option lists from current account data. May be blank if the fields are static.
getItemIdField()
Returns: String
Name of the field within a fired event's parameters that identifies the specific item the event relates to, used to record which item triggered an automation. May be blank if this trigger type does not identify items.
© 2025 Kademi Ltd