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. Each journey has a persona: the id and name of the persona it signs in as, or null for a public journey.

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.
entryobjectnoMobile only. See Entry.
persona_idstringnoA persona id from list_personas. The journey signs in as it; omitted, the journey is public.

Returns: the created journey. A persona kontrol refuses is an error block; see Persona refusals.

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

NameTypeRequiredNotes
journey_idstringyes
namestringno
descriptionstringno
stepsstring[]noReplaces the whole step list.
entryobject or nullnoMobile only. An object sets the entry; null clears it.
persona_idstringnoA persona id from list_personas. The journey signs in as it from now on.
clear_personabooleannotrue makes the journey public: it signs in as no one.

Only the fields you pass are changed. steps is a replacement, not an append. Omitting entry leaves the journey’s entry as it is; passing null removes it, so the audit starts from the app’s launch screen. Omitting both persona_id and clear_persona keeps the journey’s persona. Passing both is an error block, and nothing is sent to kontrol.

Returns: the updated journey. A persona kontrol refuses is an error block; see Persona refusals.

How a mobile audit enters the app before it runs the steps. It is one of two entries, and the tool’s input schema gives the exact object for each:

EntryFieldExample
deep_linkurl: the link the app opens"myapp://cart"
tap_pathtaps: the labels to tap, in order["Menu", "Cart"]

A tap_path needs at least one tap. An entry of any other shape is refused with Invalid journey entry and nothing is saved.

Delete a journey.

NameTypeRequired
journey_idstringyes

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

kontrol refuses a persona the journey cannot sign in as, and the tool answers with an error block carrying kontrol’s message. Nothing is saved.

RefusalMessage
persona_not_in_projectThat persona isn’t in this project.
persona_on_app_journeyAn app journey can’t run as a persona. Personas sign in to a web site.