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
+40-8Lines changed: 40 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Steps are the building blocks of a journey. This page explains the the **Hold Un
9
9
10
10
This guide explains how these steps work, their key features, and best practices for using them effectively.
11
11
12
-
## Hold until: smart pauses in journeys
12
+
## Hold Until: smart pauses in journeys
13
13
14
14
The **Hold Until** step adds a deliberate pause in a journey, waiting for specific user actions or a predefined time limit before progressing. This lets you create highly personalized experiences by responding to user behavior—or lack thereof—at the right moment.
15
15
@@ -18,7 +18,7 @@ Because the hold until step introduces a checkpoint in your journey where the ne
18
18
- Personalization, by tailoring user interactions based on their actions.
19
19
- Efficiency, helping you avoid sending irrelevant messages by waiting for meaningful triggers.
20
20
21
-
### How Hold until works
21
+
### How Hold Until works
22
22
23
23
When a journey reaches a hold until step:
24
24
@@ -28,7 +28,7 @@ When a journey reaches a hold until step:
28
28
29
29
### Configurable parameters
30
30
31
-
The following table explains the parameters you can configure for the Hold until step:
31
+
The following table explains the parameters you can configure for the Hold Until step:
@@ -59,13 +59,43 @@ For example, an onboarding journey with a `Signup Completed` event could trigger
59
59
- In one branch, the event leads to an email sequence welcoming the user.
60
60
- In another branch, the same event triggers a survey request.
61
61
62
+
As another example, consider the `Cart_Modified` event in an abandoned journey:
63
+
1. A user enters the journey by modifying their cart, which triggers the `Cart_Modified` event.
64
+
2. During the Hold Until step, the user modifies their cart four more times.
65
+
66
+
The destination payload after the Hold Until step would look like this:
67
+
68
+
```json
69
+
{
70
+
"properties": {
71
+
"journey_context": {
72
+
"Cart_Modified": {
73
+
"organization": "Duff Brewery",
74
+
"compression_ratio": 5.2,
75
+
"output_code": "not_hotdog"
76
+
},
77
+
"Cart_Modified - user updates cart": {
78
+
"organization": "Acme Corp",
79
+
"user_name": "Homer Simpson",
80
+
"output_code": "always_blue"
81
+
}
82
+
}
83
+
}
84
+
}
85
+
```
86
+
87
+
In this example:
88
+
-`Cart_Modified` captures the properties of the first event that initiated the journey.
89
+
-`Cart_Modified - user updates cart` captures the most recent modification within the Hold Until branch.
90
+
91
+
62
92
By assigning an alias to each instance of the `Signup Completed` event (like `Signup_Email` and `Signup_Survey`), you can ensure that both branches retain the specific event context needed for their respective actions.
63
93
64
94
To configure an alias, add the branch name or a custom identifier to the event name during setup. The alias will appear in the journey context and downstream payloads, allowing precise tracking and execution. Aliases should be meaningful and reflect the purpose of the event within the branch or step.
65
95
66
-
### Managing Hold until steps
96
+
### Managing Hold Until steps
67
97
68
-
Deleting a Hold until step can impact downstream steps that rely on it. When you delete a configured step, Segment displays a modal that summarizes the potential impact on related branches and steps. Review all dependencies carefully to avoid unintentionally disrupting the journey.
98
+
Deleting a Hold Until step can impact downstream steps that rely on it. When you delete a configured step, Segment displays a modal that summarizes the potential impact on related branches and steps. Review all dependencies carefully to avoid unintentionally disrupting the journey.
69
99
70
100
## Send to destination
71
101
@@ -102,10 +132,12 @@ Before activating the journey, **send a test event to verify that the payload ma
102
132
103
133
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:
104
134
- The triggering event that started the journey.
105
-
- Any events received during a Hold until step.
135
+
- Any events received during a Hold Until step.
106
136
- The properties associated with these events.
107
137
108
-
You can also optionally include profile traits to provide richer context for the destination. Here's an example of the payload structure:
138
+
You can also optionally include profile traits to provide richer context for the destination.
139
+
140
+
Here’s a detailed example of a payload structure, highlighting the journey context and how Segment enriches event data:
109
141
110
142
```json
111
143
{
@@ -164,7 +196,7 @@ To edit or delete an activation, click the destination name in the journey canva
164
196
165
197
#### Deleting activations
166
198
167
-
If you delete an activation, future instances of the journey step will fail to send data to that destination. To avoid disruptions, make sure you've configured alternative logic or destintions before removing an activation.
199
+
If you delete an activation, future instances of the journey step will fail to send data to that destination. To avoid disruptions, make sure you've configured alternative logic or destinations before removing an activation.
0 commit comments