Configuration reference

The Recorder widget’s configuration — the object passed as overrides in React, or set as the config property on the Custom Element — follows a JSON Schema shipped with the package. That schema is not just documentation: it lets an editor or an agent complete and validate a configuration object without guessing at a key or a value, before it ever reaches the widget. The tables below are generated from it, section by section, so they list exactly the keys the widget accepts in the version you install.

A minimal configuration

Every key is optional: send only the settings you want to change, and the recorder keeps its own value for the rest. The paths below are the ones listed in the tables on this page.

widget configuration

{
  "version": 2,
  "layout": {
    "inputStyle": "underlined"
  },
  "fields": {
    "message": {
      "visible": true
    }
  },
  "behavior": {
    "messageEnabled": true
  }
}

`version`

Path	Type	Default	Accepted values	Description
`version`	`enum`	None declared	`1` `2`	Not documented in the schema

`styles`

Path	Type	Default	Accepted values	Description
`styles`	`object`	None declared	No fixed list	Not documented in the schema

`layout`

Path	Type	Default	Accepted values	Description
`layout.steps`	`boolean`	None declared	No fixed list	Not documented in the schema
`layout.inputStyle`	`enum`	None declared	`boxed` `underlined`	Not documented in the schema

`display`

Path	Type	Default	Accepted values	Description
`display.recorder.stepHeader`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.recorder.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.recorder.infoPrimary`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.recorder.infoSecondary`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.stepHeader`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.mandatoryNote`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.sender.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.sender.description`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.recipient.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.recipient.description`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.message.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.message.description`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.schedule.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.form.sections.schedule.description`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.finish.title`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.finish.discoverText`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.finish.discoverButton`	`boolean`	None declared	No fixed list	Not documented in the schema
`display.finish.restartButton`	`boolean`	None declared	No fixed list	Not documented in the schema

`fields`

Path	Type	Default	Accepted values	Description
`fields.firstname.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.firstname.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.firstname.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.firstname.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.lastname.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.lastname.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.lastname.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.lastname.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.senderEmail.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.senderEmail.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.senderEmail.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.senderEmail.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.receiverEmail.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverEmail.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverEmail.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverEmail.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.receiverPhone.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverPhone.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverPhone.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.receiverPhone.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.birthday.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.birthday.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.birthday.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.birthday.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.country.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.country.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.country.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.country.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.message.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.message.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.message.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.message.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.scheduleDate.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleDate.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleDate.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleDate.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`fields.scheduleTime.visible`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleTime.label`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleTime.placeholder`	`boolean`	None declared	No fixed list	Not documented in the schema
`fields.scheduleTime.requiredLabelSuffix`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`

`behavior`

Path	Type	Default	Accepted values	Description
`behavior.noForm`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.messageEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.scheduleEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.countryEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.birthdayEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.receiverEmailEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.receiverPhoneEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.emailOptional`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.consentTitleEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema
`behavior.additionalConsentsEnabled`	`boolean`	None declared	No fixed list	Not documented in the schema

`recorder`

Path	Type	Default	Accepted values	Description
`recorder.permissionGate.panelBackgroundColor`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 256`
`recorder.permissionGate.panelBackgroundImageUrl`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`recorder.permissionGate.panelBackgroundSize`	`enum`	None declared	`cover` `contain` `auto`	Not documented in the schema
`recorder.permissionGate.panelBackgroundPosition`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 256`
`recorder.permissionGate.panelBackgroundRepeat`	`enum`	None declared	`no-repeat` `repeat` `repeat-x` `repeat-y`	Not documented in the schema
`recorder.permissionGate.heroAssetUrl`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`recorder.permissionGate.heroAlt`	`string`	None declared	No fixed list	Not documented in the schema Limits `max length 2048`
`recorder.permissionGate.heroWidth`	`number`	None declared	No fixed list	Not documented in the schema Limits `max 4096, exclusive min 0`
`recorder.permissionGate.heroHeight`	`number`	None declared	No fixed list	Not documented in the schema Limits `max 4096, exclusive min 0`
`recorder.permissionGate.heroAnimation`	`enum`	None declared	`defaultPulse` `none`	Not documented in the schema