Skip to content

Journey tools

A journey is a named user flow described in ordered steps. Journeys are what a cloud audit drives a screen reader through; four tools manage them.

List saved journeys for a project.

NameTypeRequired
project_idstringyes

Returns: the project’s journeys. Not paginated.

The returned ids are what start_agentic_audit and set_journey_group_members take.

Create a new test journey for a project.

NameTypeRequiredNotes
project_idstringyes
namestringyes
descriptionstringno
stepsstring[]noOrdered list of steps describing the user flow.

Returns: the created journey.

Update an existing journey’s name, description, or steps.

NameTypeRequiredNotes
journey_idstringyes
namestringno
descriptionstringno
stepsstring[]noReplaces the whole step list.

Only the fields you pass are changed. steps is a replacement, not an append.

Returns: the updated journey.

Delete a journey.

NameTypeRequired
journey_idstringyes

Returns: the confirmation line Deleted journey: <id>.