Skip to content

Capture Agent Entry Point

POST
/agent/onboarding/entry-point

Record which product the customer signed up for. FIRST WRITER WINS.

The entry point maps 1:1 to a plan template, so it chooses what the agent proposes doing first. It is a one-shot ATTRIBUTION, not a settable preference: if the org already has one, this call changes nothing and reports the existing value.

Read captured rather than the status code - a 200 with captured: false means someone else got there first, which is a normal outcome and not an error.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of CaptureEntryPointRequest.

object
entry_point
required

The signup entry point. Maps 1:1 to a plan template, so this chooses what the agent will propose doing first. FIRST WRITER WINS: if the org already has one captured, this call reports the existing value and changes nothing.

string
Allowed values: dialer sequencer marketplace dev calendar email_inbox full

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