Skip to main content
Defined in: forms/types.ts:216 Options of flow().form(definition, opts).

​
Properties

​
stateKey?

Defined in: forms/types.ts:218 c.state key the answers object is stored under. Default: the form id.

​
flatten?

Defined in: forms/types.ts:220 Also copy every answer to c.state[field.name]. Default false.

​
mode?

Defined in: forms/types.ts:222 Force a rendering mode. Default 'auto'.

​
nativeId?

Defined in: forms/types.ts:227 Provider-side id of the published native form (on the Cloud API: a WhatsApp Flow id, or its name). Providers may also map definition.id to it in their config.

​
timeout?

Defined in: forms/types.ts:229 Wait timeout per answer (degraded) / for the whole submission (native). Default: the flow’s.

​
maxAttempts?

Defined in: forms/types.ts:231 Total answers accepted per field (degraded) or submissions (native), the first included. Default 3.

​
retries?

Defined in: forms/types.ts:233 Retries after the first answer (retries: N = maxAttempts: N + 1). Breaking in 2.0: it meant total attempts (without maxAttempts, the bot warns once).

​
skipWord?

Defined in: forms/types.ts:235 Degraded mode: word that skips an optional field. Default: the locale’s core.form.skipWord ('skip' in English, 'omitir' in Spanish).

​
pendingMessage?

Defined in: forms/types.ts:237 Native mode: reply sent when the user writes instead of submitting the form.