Journey webhooks and webhook payloads
This article explains how to use journey webhooks and webhook payloads in Tarvent Journeys.
What we'll cover
1 Concepts
Purpose
This article explains how to use Journey webhooks and webhook payloads in Tarvent Journeys.
Where to find it
Open the journey editor and use the left panel, the journey map, or the right-side editor depending on the feature you are working with.
Save changes
After changing settings, click Save to keep the update.
Sample payload
The Webhook step includes a View sample response option so you can review the payload format before integrating.
Note: Most journey items are configured in the right-side editor after you click the item in the journey map.
2 How to use it
Here are the steps:
- Open the journey you want to work with.
- Locate the item in the journey map or add it from Add if it is not already on the map.
- Click the item to open the editor on the right side.
- Configure the settings for your use case, and then click Save.
Pro-tip: Use View sample response in the Webhook step to confirm the payload format before connecting your external system.
3 Use cases and examples
Common use cases:
- Send journey data to an external system in real time
- Trigger a downstream process after a milestone
- Sync journey activity with an internal workflow tool
Pro-tip: Keep the journey path simple first, and then add more conditions or branches after the basic flow is working.
4 Step notes
- Tarvent will make a single attempt at posted the JSON data to your webhook URL. If the server is down or the call is not successful, no further attempts will be made.
- The "EventType" property will always be null and the Initiator source will always be "Journey".
- The collection of profile records will vary depending on the number of custom data fields have been created for the associated audience.
5 FAQ
Can I use this in a running journey?
Most journey features can be updated while a journey is running, but test carefully when contacts are already active.
Do journey settings still apply?
Yes. Journey-level settings and contact criteria continue to affect how contacts move through the journey.
What is the safest way to test?
Use a small internal segment or a draft journey before launching to a larger audience.
6 Need help?
If you need help with setup or troubleshooting, contact support. We are happy to help.