end_automation step.
Before you begin
Prepare the resources your journey will use:- Publish any email or push templates you plan to send.
- Verify the sending domain used by email steps.
- Configure a push app before adding push steps.
- Create any audiences or topics the automation will update.
Build a journey
- Create an automation and give it a clear name and description.
- Choose the event that starts the journey, such as
user.createdororder.completed. - Add the actions, waits, and conditions the customer should move through.
- Connect each step to the next step. Conditions and event waits can lead to different branches.
- Save the draft, then validate it before publishing.
- Start when
user.createdis received. - Send a welcome email.
- Wait for
user.activatedfor up to two days. - Send a getting-started push when the event arrives.
- Send a reminder email when the wait times out.
Configure the trigger
The trigger event name must match the event sent to Sendrealm. You can also add filters when only some occurrences should start the automation. Use correlation when later events must be matched to the same order, checkout, subscription, or other business object. A correlatedwait_for_event step should use the same correlation key as the trigger.
Choose the right steps
- Use
delayto continue after a fixed amount of time. - Use
wait_for_eventwhen the next path depends on customer behavior. Configure both the matched and timeout paths. - Use
conditionto branch using contact or event data. - Use email and push template steps for messages. These steps reference published templates rather than copying message content into the automation.
- Use audience, topic, and contact steps to keep customer data and preferences in sync.
- Use
end_automationwhen you want a branch to finish explicitly.
Validate and test
Validation checks that the journey has one trigger, valid connections, reachable steps, no cycles, complete branches, and valid resource references. Fix every validation issue before publishing. Saving a draft does not activate the journey. Use a test run to exercise the current draft without sending messages or changing production data. Test runs let you inject synthetic events and advance virtual time, making it possible to verify event waits, delays, and timeout branches without waiting in real time.Publish and operate
Publishing creates the version used for new production runs. Future edits remain in the draft until you validate and publish again. After publishing, use the Runs page to inspect the path taken by each customer, step status, waits, linked messages, and errors. Pausing prevents new runs from starting; it does not cancel runs already in progress. Resume the automation when it is ready to accept new events again.How it maps to the API
The builder and API use the same automation model:definition: executable trigger, steps, and connectionseditor_layout: node positions and viewport metadata
definition affects execution. editor_layout preserves the visual arrangement for future editing.
Best practices
- Start with one customer outcome and keep each journey focused.
- Always provide a timeout path for
wait_for_eventsteps. - Test both successful and timeout branches before publishing.
- Review referenced templates, audiences, topics, domains, and push apps when moving a journey between projects.
- Publish a new version after changing behavior; saving the draft alone does not update production runs.