Skip to main content

Retry prompt (v1)

Preview

RETRY_PROMPT:v1 is in preview. The step API is not yet finalised and may change before general availability.

Presents the user with a retry or abandon choice after a verification step is cancelled

RETRY_PROMPT:v1 is a lightweight interstitial step that pauses the flow after a cancelled verification session and asks the user whether to retry the previous step or abandon the session. It has no configuration options and produces no data blocks — its only output is the user's decision, expressed as a route.

Pair it with a verification step (such as SPHINX:v3). The verification step routes cancelled sessions to RETRY_PROMPT:v1 via its cancelled route; the retry prompt routes the user's decision back to the verification step (rollback) or forward to a rejection step.


Key features

  • Zero-config interstitial: No configuration options and no output data blocks. The step's only function is capturing the user's retry or abandon decision.
  • Rollback routing: The retry route must use a rollback transition, which restores the flow to the upstream verification step and makes its prior data blocks available again.
  • Attempt cap: rollback.maxAttempts limits how many retries the user may make before the session aborts automatically.
  • Implicit abandonment: When the user chooses to abandon, the session terminates immediately — no explicit abandon route is needed.

Configuration

This step has no configuration options.


Example wiring

[
{ "id": "SPHINX", "type": "SPHINX:v3",
"options": { "config": { ... } },
"next": [
{ "port": "verified", "id": "END_ACCEPTED" },
{ "port": "fraud_detected", "id": "END_REJECTED" },
{ "port": "cancelled", "id": "RETRY_PROMPT" }
]
},
{ "id": "RETRY_PROMPT", "type": "RETRY_PROMPT:v1", "options": {},
"next": [
{ "port": "retry", "id": "SPHINX", "type": "rollback", "rollback": { "maxAttempts": 3 } }
]
},
{ "id": "END_ACCEPTED", "type": "END", "options": { "outcome": "accepted" }, "next": [] },
{ "id": "END_REJECTED", "type": "END", "options": { "outcome": "rejected" }, "next": [] }
]

Input data blocks

None.


Routes

RouteDescription
retryUser chose to retry. Must be a rollback transition pointing back to the upstream verification step.

When the user chooses to abandon, the session terminates immediately. No additional route is required — the workflow aborts automatically, with no abandon port needed. The retry route must be declared with "type": "rollback". Use rollback.maxAttempts to cap how many times the user may retry before the flow aborts.


Notes

  • RETRY_PROMPT:v1 produces no data blocks and does not modify flow state beyond recording the user's decision.
  • The Player presents the retry/abandon UI for this step type.