Experience Preview API

  • Published on Sep 12, 2025
  • 1 minute(s) read
Prev Next
Get
/platform/v3/api/messaging/client/{client_id}/journey/{journey_id}/trigger/{trigger_id}/preview

Get a rendered HTML preview of a journey step. Looks up the journey for the given client and journey ID, finds the executable step matching the trigger ID, and returns the rendered HTML.

Path parameters
client_id
stringRequired

The client identifier

journey_id
stringRequired

The journey identifier

trigger_id
stringRequired

The relay trigger id or client trigger id

Responses
200

HTML preview of the journey step

{
  "html": "
Step Title
Step content here
    ...
"
}
object
html
string

Rendered HTML for the journey step

404

Journey or step not found

{
  "status": 404,
  "response": "Trigger not found"
}
object
status
integer
response
string