Skip to content

Commit dc9cb2a

Browse files
committed
fix code samples [netlify-build]
1 parent 46f5340 commit dc9cb2a

File tree

1 file changed

+40
-8
lines changed

1 file changed

+40
-8
lines changed

src/engage/journeys/event-triggered-journeys-steps.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Steps are the building blocks of a journey. This page explains the the **Hold Un
99

1010
This guide explains how these steps work, their key features, and best practices for using them effectively.
1111

12-
## Hold until: smart pauses in journeys
12+
## Hold Until: smart pauses in journeys
1313

1414
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.
1515

@@ -18,7 +18,7 @@ Because the hold until step introduces a checkpoint in your journey where the ne
1818
- Personalization, by tailoring user interactions based on their actions.
1919
- Efficiency, helping you avoid sending irrelevant messages by waiting for meaningful triggers.
2020

21-
### How Hold until works
21+
### How Hold Until works
2222

2323
When a journey reaches a hold until step:
2424

@@ -28,7 +28,7 @@ When a journey reaches a hold until step:
2828

2929
### Configurable parameters
3030

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:
3232

3333
| Parameter | Details |
3434
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -59,13 +59,43 @@ For example, an onboarding journey with a `Signup Completed` event could trigger
5959
- In one branch, the event leads to an email sequence welcoming the user.
6060
- In another branch, the same event triggers a survey request.
6161

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+
6292
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.
6393

6494
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.
6595

66-
### Managing Hold until steps
96+
### Managing Hold Until steps
6797

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.
6999

70100
## Send to destination
71101

@@ -102,10 +132,12 @@ Before activating the journey, **send a test event to verify that the payload ma
102132

103133
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:
104134
- 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.
106136
- The properties associated with these events.
107137

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:
109141

110142
```json
111143
{
@@ -164,7 +196,7 @@ To edit or delete an activation, click the destination name in the journey canva
164196

165197
#### Deleting activations
166198

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.
168200

169201
### Handling missing attributes
170202

0 commit comments

Comments
 (0)