Skip to content

Post Agent Onboarding Catchup

POST
/agent/onboarding/catchup

Post ONE batched summary of what finished while the customer was away.

IDEMPOTENT by watermark: a marker on the previous catch-up message is the high-water mark, so a repeat call posts nothing and comes back posted: false. Below the app’s minimum card count it is also a no-op - a single completed card does not need a summary.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of OnboardingCatchupRequest.

object
session_id
required

The proactive-setup canvas session id.

string

Responses

200

Successful Response

object
data
required

An open envelope for an onboarding or discovery result.

Open on purpose. Discovery state carries a per-field coverage matrix whose field set is the product’s own onboarding questionnaire - it changes as the questionnaire does, and a pinned mirror would silently DROP a field the customer had answered. On a surface whose whole job is “what do we still not know about you”, a dropped field reads as an answered question.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string