Developer/IT > Whisbi API > API Reference > Engage > Active viewer form

Active viewer form

The object containing the fields in the Engage form appears when the customer enters an Engage live broadcast.

NameDescriptionRequired
name whisbi.OneToManyActiveViewerFormNameConfig Object containing the properties for the Name field on the Engage form Optional

Body styles

The styles specific to the Engage widget

NameDescriptionRequired
backgroundColor String Background color of the Engage widget. This background is always visible except when the broadcast is being displayed. It uses the same format as the CSS property background-color Optional

Floating Button styles

The styles specific to the Engage floating button

NameDescriptionRequired
floatingButton.blinkLabel whisbi.BlinkLabelStyles The styles of the overlapped layer the appears over the agent image on the floating button Optional

Blink Label styles

NameDescriptionRequired
backgroundColor String Background color of the layer that appears overlapped to the agent image on the floating button Optional
textColor String Color of the text that appears overlapped to the agent image on the floating button Optional

Live Help Ribbon styles

The styles specific to the Engage Live Help Ribbon

NameDescriptionRequired
backgroundColor String The background color of the label Optional
textColor String The text color color of the label Optional

Name config

Object containing the properties for the Name field on the Engage form

NameDescriptionRequired
maxLength Number Maximum number of characters allowed in the name field Optional
Default: 20
maxWords Number Maximum number of words allowed in the name field Optional
Default: 2