Complete Journey
POST /v2/widget/journeys/{journey_id}/complete
Operation
| Operation ID | completeJourney |
| Tags | Untagged |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| journey_id * | path | id | |
| — |
Request body
object
| Field | Type | Description |
|---|---|---|
| outcome | WidgetCompletion | Discriminated union over `(kind, outcome)`. See `02-widget-runtime.md` §10.1 for the exhaustive variant list. |
Responses
200
OK
object
| Field | Type | Description |
|---|---|---|
| journey_id * | id | UUID v4. |
| type * | enum (1) | journey_progress |
| status * | enum (5) | not_startedin_progresscompletedreached_deadlinecancelled |
| current_page_id | string (uuid) | |
| next_page_id | string (uuid) | |
| total_pages * | integer | |
| pages_completed * | integer | |
| steps * | object[] | |
| engagement_state * | enum (5) | noneemail_openedmessage_clickedpage_viewedpage_engaged |
| computed_at * | emitted_at | RFC 3339 / ISO 8601 timestamp. |
Example request
POST https://api.digitalonboarding.com/v2/widget/journeys/{journey_id}/complete
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>
{ /* request body matching schema above */ }