A funnel trigger fired when a lead submits a contact form, optionally scoped to a specific website and to a specific contact form path. Configured with an optional website name and an optional form path; when a path is given, it is matched against the exact path the contact form was submitted from, eg "/blogs/article1".
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | A human readable summary of this trigger's configuration, used in the funnel automation admin UI. |
| fields | List<Pair<ExtraField,Object>> | The editable configuration fields for this trigger, paired with their current values, used to render the trigger's edit form in the funnel automation admin UI. |
| funnelTriggerTypeId | String | Identifier of the funnel trigger type that creates this trigger, used to look up the matching ContactFormFunnelTriggerType and to select this class during JSON deserialisation. |
| path | String | Exact contact form path this trigger is scoped to, eg "/blogs/article1". Null or blank means the trigger matches submissions of any contact form. |
| websiteName | String | Name of the website this trigger is scoped to. Null or blank means the trigger matches contact form submissions on any website. |
Methods
getFunnelTriggerTypeId()
Returns: String
Identifier of the funnel trigger type that creates this trigger, used to look up the matching ContactFormFunnelTriggerType and to select this class during JSON deserialisation.
getFields()
Returns: List<Pair<ExtraField,Object>>
The editable configuration fields for this trigger, paired with their current values, used to render the trigger's edit form in the funnel automation admin UI.
getDescription()
Returns: String
A human readable summary of this trigger's configuration, used in the funnel automation admin UI.
getWebsiteName()
Returns: String
Name of the website this trigger is scoped to. Null or blank means the trigger matches contact form submissions on any website.
getPath()
Returns: String
Exact contact form path this trigger is scoped to, eg "/blogs/article1". Null or blank means the trigger matches submissions of any contact form.