Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 3.48 KB

WebAllOf.md

File metadata and controls

29 lines (22 loc) · 3.48 KB

WebAllOf

Properties

Name Type Description Notes
type String To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint. [optional]
brandColor String This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. [optional]
fixedIntroPane Boolean When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. [optional]
conversationColor String This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. [optional]
actionColor String This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. [optional]
displayStyle String Choose how the messenger will appear on your website. Must be either button or tab. [optional]
buttonIconUrl String With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. [optional]
buttonWidth String With the button style Web Messenger, you have the option of specifying the button width. [optional]
buttonHeight String With the button style Web Messenger, you have the option of specifying the button height. [optional]
integrationOrder List<String> Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. [optional]
businessName String A custom business name for the Web Messenger. [optional]
businessIconUrl String A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. [optional]
backgroundImageUrl String A background image url for the conversation. Image will be tiled to fit the window. [optional]
originWhitelist List<String> A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme &quot;://&quot; host [ &quot;:&quot; port ], where scheme is http or https. [optional]
prechatCapture PrechatCapture Object whose properties can be set to specify the add-on’s options. See the guide to learn more about Prechat Capture. [optional]
canUserSeeConversationList Boolean Allows users to view their list of conversations. By default, the list of conversations will be visible. This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`. [optional]
canUserCreateMoreConversations Boolean Allows users to create more than one conversation on the web messenger integration. [optional]
attachmentsEnabled Boolean Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center. [optional] [readonly]