Journey goal achieved when the lead submits the form at this node. matches() checks that an incoming FormSubmittedEvent's form node id equals the lead's current goal before advancing to nextNodeId, so a form goal only accepts submissions of the form it represents while the lead is sitting at that node.
Group: Journeys
Extends: Goal
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short label for this goal, naming the form it waits on. |
| formDataFieldName | String | Name of the lead field the submitted form data is stored under. Defaults to this node's id with a "-data" suffix when not explicitly configured. |
| formPath | String | Repository path of the form this goal waits on a submission of. |
| nextNodeId | String | Identifier of the journey node to transition into once the form is submitted. |
Methods
getDescription()
Returns: String
Short label for this goal, naming the form it waits on.
getFormPath()
Returns: String
Repository path of the form this goal waits on a submission of.
getFormDataFieldName()
Returns: String
Name of the lead field the submitted form data is stored under. Defaults to this node's id with a "-data" suffix when not explicitly configured.
getNextNodeId()
Returns: String
Identifier of the journey node to transition into once the form is submitted.