Widget Settings Object


Widget settings for the AI Site Chat (v2).

This version introduces mode-based configuration for chat handlers and enhanced scheduling options. It replaces the v1 widget settings.

Properties
activeHoursActiveHours

Times the AI assistant is available on the site with new mode-based configuration.


aiBehaviorAIBehavior

Defines how the AI assistant functions during AI active hours.

For instance, when WidgetSettings.active_hours.mode is set to ALWAYS_WITH_AI or SCHEDULED with a schedule that includes time frames with FrameHandler set to AI_CHAT, these settings will determine the behavior of the chat for site visitors during those hours.


commonBehaviorCommonBehavior

createdDatestringRead-onlyformat date-time

Date and time the widget settings were created.


idstringRead-onlyformat GUID

Widget settings ID.


offlineBehaviorOfflineBehavior

Defines how the AI assistant functions during offline hours.

Valid field combinations:

  • hide_widget: true — hides the widget entirely. show_contact_form and allow_chat are ignored.
  • hide_widget: false, allow_chat: false, show_contact_form: true — shows a contact form only, no chat input.
  • hide_widget: false, allow_chat: true, show_contact_form: false — allows visitors to type messages with no contact form.
  • hide_widget: false, allow_chat: true, show_contact_form: true — shows the chat input and a contact form.

revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the widget settings are updated. To prevent conflicting changes, the current revision must be passed when updating the widget settings.


updatedDatestringRead-onlyformat date-time

Date and time the widget settings were updated.


wixUserBehaviorWixUserBehavior

Defines how the AI assistant functions during Wix User active hours.

For instance, when WidgetSettings.active_hours.mode is set to ALWAYS_WITH_WIX_USER or SCHEDULED with a schedule that includes time frames with FrameHandler set to WIX_USER_CHAT, these settings will determine the behavior of the chat for site visitors during those hours.

Did this help?