# Attributes

## Widget <a href="#messenger-attributes" id="messenger-attributes"></a>

### Widget init attributes

These attributes will modify the behaviour of the widget and how the agent will respond to messages.&#x20;

<table><thead><tr><th width="160">Attribute</th><th width="180">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>string</td><td>The API key of your project can be found in your <mark style="color:purple;">project/implementation</mark> page. </td></tr><tr><td>language</td><td><a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1 language code</a></td><td>The current language of your website visitor. Must be <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1 </a></td></tr><tr><td>open</td><td>boolean</td><td>Standard open the widget</td></tr><tr><td>hide</td><td>boolean</td><td>Hide or show the widget on your website.</td></tr><tr><td>config</td><td><a href="#config-attribute">config attribute</a></td><td>Widget specific configuration. This will change the behaviour of your widget</td></tr><tr><td>context <br><br></td><td>record&#x3C;string, Boolean | number | string | undefined></td><td>Extra context that should be used by the agent to provide accurate answers. </td></tr><tr><td>customerData</td><td><a href="../../attributes#customer-data">customer data</a></td><td>Data to identify the current customer.</td></tr></tbody></table>

### Widget embed attributes

These attributes will modify the behaviour of the widget and how the agent will respond to messages.&#x20;

<table><thead><tr><th width="160">Attribute</th><th width="180">Type</th><th>Description</th></tr></thead><tbody><tr><td>apiKey</td><td>string</td><td>The API key of your project can be found in your <mark style="color:purple;">project/implementation</mark> page. </td></tr><tr><td>selector</td><td>string</td><td><p>Select the HTML tag where in the widget must be embedded. </p><p><em>Works the same as <code>document.querySelector</code></em></p></td></tr><tr><td>language</td><td><a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1 language code</a></td><td>The current language of your website visitor. Must be <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1 </a></td></tr><tr><td>context </td><td>record&#x3C;string, Boolean | number | string | undefined></td><td>Extra context that should be used by the agent to provide accurate answers.</td></tr><tr><td>customerData</td><td><a href="../../attributes#customer-data">customer data</a></td><td>Data to identify the current customer. </td></tr></tbody></table>

### Config attribute

These attributes are used to change the behaviour of your widget

<table><thead><tr><th width="207">Attribute</th><th width="108">Type</th><th>Description</th></tr></thead><tbody><tr><td>notificationsEnabled</td><td>boolean</td><td>Allow notifications to be shown when widget is closed. Default this is enabled.</td></tr></tbody></table>

## Text customization <a href="#text-customization" id="text-customization"></a>

Most of the static text displayed in the form can be customized. However, text that is set in the form configuration or generated by your assistant cannot be altered.

The following text options can be customized during initialization or using `setText()`:

#### Text object <a href="#text-object" id="text-object"></a>

| launcherAriaLabelClose                | Close chat widget                                                                                                                          | ARIA label for the button that closes the chat widget (when the widget is open).                     |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| launcherAriaLabelOpen                 | Open chat widget                                                                                                                           | ARIA label for the button that opens the chat widget (when the widget is closed).                    |
| closeAriaLabel                        | Close chat widget                                                                                                                          | ARIA label for the primary close button inside the chat window header.                               |
| clearNotifications                    | Close chat notifications                                                                                                                   | Text or ARIA label for dismissing or clearing notification badges.                                   |
| leadGenerationTitle                   | Talk to a real person                                                                                                                      | Title of the lead generation or "Contact Me" form/modal.                                             |
| leadGenerationDescription             | Provide your email address and one of our colleagues will reach out to you.                                                                | Description or instructional text for the lead generation form.                                      |
| leadGenerationCloseAriaLabel          | Close contact me modal                                                                                                                     | ARIA label for the close button of the contact form modal.                                           |
| leadGenerationSubmitButton            | Contact me                                                                                                                                 | Text for the submission button on the lead generation form.                                          |
| leadGenerationNotificationFailed      | We were unable to process your request at this time. Please try again later or explore our available resources for immediate assistance.   | Error message shown when the lead generation submission fails.                                       |
| leadGenerationButton                  | Contact me                                                                                                                                 | Text for the button that triggers/opens the lead generation flow.                                    |
| isOptionalLabel                       | (optional)                                                                                                                                 | Label appended to form fields that are optional.                                                     |
| errorIsRequired                       | This field is required                                                                                                                     | Error message displayed when a required field is left empty.                                         |
| errorMaxLength                        | Text cannot be longer then {maxLength, plural, =1 {# character} other {#characters}}                                                       | Error message when text input exceeds the maximum length. (`{maxLength}` is a placeholder).          |
| errorUnsafeNumber                     | Number is to big                                                                                                                           | Error message for number inputs that exceed safe JavaScript limits.                                  |
| errorInvalidEmail                     | It seems like the email address you've entered is invalid                                                                                  | Error message for invalid email format validation.                                                   |
| messageToLong                         | Your message is too long. Please try to shorten it.                                                                                        | Warning message when a user attempts to send a chat message that is too long.                        |
| sendButtonAriaLabel                   | Send message                                                                                                                               | ARIA label for the message send button.                                                              |
| sourcesLabel                          | Sources                                                                                                                                    | Label displayed above the list of knowledge sources/citations.                                       |
| sourcesShowMoreAriaLabel              | Show all sources                                                                                                                           | ARIA label for the button to expand and show all hidden sources.                                     |
| positiveVoteAriaLabel                 | This answer is helpful                                                                                                                     | ARIA label for the positive (e.g., thumbs-up) feedback button.                                       |
| negativeVoteAriaLabel                 | This answer is not helpful                                                                                                                 | ARIA label for the negative (e.g., thumbs-down) feedback button.                                     |
| dropzoneTitle                         | Add files                                                                                                                                  | Title displayed in the file upload dropzone area.                                                    |
| dropzoneDescription                   | Drop any file here to add it to the conversation                                                                                           | Description displayed in the file upload dropzone area.                                              |
| fileErrorLimitReached                 | Only {limit} files can be uploaded                                                                                                         | Error message when the file count limit is reached. (`{limit}` is a placeholder).                    |
| fileErrorSizeLimit                    | You've reached the {sizeLimit} upload limit for this message.                                                                              | Error message when the message's total file size limit is reached. (`{sizeLimit}` is a placeholder). |
| fileErrorOrganizationLimitReached     | We're unable to accept file uploads at the moment. Please check back soon.                                                                 | Error message when file uploads are disabled due to organization limits.                             |
| fileErrorUnsupportedType              | File type is not supported.                                                                                                                | Error message when an unsupported file type is uploaded.                                             |
| fileErrorCloseButtonAriaLabel         | Hide error                                                                                                                                 | ARIA label for the file upload error banner close button.                                            |
| fileFailedAriaLabel                   | Failed to upload file                                                                                                                      | ARIA label for the failed file upload icon/status.                                                   |
| fileIsUploadingAriaLabel              | Uploading file                                                                                                                             | ARIA label for the file uploading status indicator.                                                  |
| fileDeleteAriaLabel                   | Delete file                                                                                                                                | ARIA label for the button to delete an uploaded file.                                                |
| uploadAttachmentButtonAriaLabel       | Upload attachment                                                                                                                          | ARIA label for the button to open the file upload dialog.                                            |
| carouselPreviousControlAriaLabel      | View previous file                                                                                                                         | ARIA label for the control to view the previous file in a file carousel.                             |
| carouselNextControlAriaLabel          | View next file                                                                                                                             | ARIA label for the control to view the next file in a file carousel.                                 |
| messageToolCallFailedTooltip          | Failed                                                                                                                                     | Tooltip text displayed when an agent's tool call fails.                                              |
| messageToolCallFailedScreenReader     | Failed                                                                                                                                     | Screen reader text for a failed agent tool call status.                                              |
| messageToolCallSucceededTooltip       | Succeeded                                                                                                                                  | Tooltip text displayed when an agent's tool call succeeds.                                           |
| messageToolCallSucceededScreenReader  | Succeeded                                                                                                                                  | Screen reader text for a successful agent tool call status.                                          |
| conversationErrorContentFilter        | Your request couldn't be processed due to our content guidelines. Please try a different question.                                         | Error message when a user's message is blocked by content filters.                                   |
| conversationErrorUnknown              | An unexpected error stopped me from responding. Please try again.                                                                          | Generic error message for an unexpected conversation failure.                                        |
| conversationErrorNotResponding        | {name} is currently experiencing some technical difficulties and can't provide an answer at the moment. Please try again in a few minutes. | Error message when the AI assistant is temporarily unavailable. (`{name}` is a placeholder).         |
| conversationErrorMessageLimitExceeded | An unexpected error stopped me from responding. Please try again.                                                                          | Error message displayed when the user/session has exceeded a message limit.                          |
