You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/engage/journeys/event-triggered-journeys-steps.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,11 +40,15 @@ The following table explains the parameters you can configure for the Hold Until
40
40
41
41
#### Send profiles back to the beginning of this step
42
42
43
-
The Hold Until step can restart when a specified event reoccurs. This ensures that the hold duration resets and the [journey context](/docs/engage/journeys/journey-context/) updates with the most recent event data.
43
+
The Hold Until step can restart when a specified event reoccurs. This resets the hold duration and updates the [journey context](/docs/engage/journeys/journey-context/) with the most recent event data.
44
44
45
-
When the same event occurs again, the hold timer resets and the journey context is updated with the latest event data. For example, in an abandoned cart journey, if a user modifies their cart, restarting the step ensures updated cart contents and prevents premature follow-ups.
45
+
When the same event occurs again, the hold timer resets, and Segment updates the journey context with the latest event data. However, Segment only includes events in the journey context if the profile follows the branch where the event was processed.
46
46
47
-
Enable this feature by selecting Send profiles back to the beginning of this step each time this branch event occurs in the step configuration. Segment recommends putting branches for recurring events at the top of the list to improve readability.
47
+
For example, in an abandoned cart journey, if a user modifies their cart during the hold period, the cart contents are updated, and the two-hour timer resets. This prevents premature follow-ups and ensures the latest data is used.
48
+
49
+
Enable this feature by selecting **Send profiles back to the beginning of this step each time this branch event occurs** in the step configuration. For more details about how journey context handles triggering events, see [Destination Event Payload Schema](/docs/engage/journeys/event-triggered-journeys-steps#destination-event-payload-schema).
50
+
51
+
Segment recommends putting branches for recurring events at the top of the list to improve readability.
48
52
49
53

50
54
@@ -118,7 +122,7 @@ Here’s how to configure this step within a journey:
118
122
- Choose the destination for the data.
119
123
- (Optional:) Assign a unique name for clarity on the journey canvas.
120
124
2. Choose the action:
121
-
- Define the change to trigger in the destination, like adding a user to a list or updating a record.
125
+
- Define the change to trigger in the destination, like updating a record.
122
126
- For Destination Functions, the behavior is defined in the function code, so no action selection is needed.
123
127
3. Configure and map the event:
124
128
- Name the event sent to the destination.
@@ -131,8 +135,8 @@ Before activating the journey, **send a test event to verify that the payload ma
131
135
### Destination event payload schema
132
136
133
137
The events that Segment sends to destinations from Event-Triggered Journeys include an object called `journey_context` within the event’s properties. The `journey_context` object contains:
134
-
- The triggering event that started the journey.
135
-
-Any events received during a Hold Until step.
138
+
- The triggering event that started the journey, unless it was replaced by a new event in a Hold Until step.
139
+
-Events received during a Hold Until step, but only if the profile followed the branch where the event happened.
136
140
- The properties associated with these events.
137
141
138
142
You can also optionally include profile traits to provide richer context for the destination.
0 commit comments