Skip to content

Interface: FormSnapshot

The landing page's form as the SDK saw it when this inbound message was sent.

Properties

PropertyTypeDescription
askedFieldId?string | nullThe field the SDK's control was asking when this message was sent, if any.
capturedAtstringISO-8601 from the SDK's clock.
contextstring | null-
disclosurestring | nullConsent or disclosure text shown beside the submit button; read-only for the agent.
experience?FormSnapshotExperienceAbsent until the page has rendered a stage block.
fieldsFormFieldSnapshot[]DOM order. Hidden, submit, button, password and file inputs are omitted.
goalstring | null-
landingPageIdstringThe data-nam-landing-page id; also the session's routing key.
lastTouchedFieldIdstring | null-
sdk?FormSnapshotSdkAbsent on older SDKs, which render only the five field actions.
submitMode?"confirm" | "auto"Absent on older SDKs, which only ever ran in confirm.
submitState"not_submitted" | "submitting" | "submitted" | "failed"-
trigger| "assist_start" | "user_message" | "field_change" | "control_answer" | "submit_result" | "card_choice" | "sheet_action"-

Proprietary. All rights reserved.