zendesk-messaging-client
    Preparing search index...

    Type Alias WebReadable

    WebReadable: IntegrationReadable & { type: "web" } & {
        actionColor?: string;
        attachmentsEnabled?: boolean;
        backgroundImageUrl?: string;
        brandColor?: string;
        businessIconUrl?: string;
        businessName?: string;
        buttonHeight?: string;
        buttonIconUrl?: string | null;
        buttonWidth?: string;
        canUserCreateMoreConversations?: boolean;
        canUserSeeConversationList?: boolean;
        conversationColor?: string;
        displayStyle?: string;
        fixedIntroPane?: boolean;
        integrationOrder?: string[] | null;
        originWhitelist?: string[] | null;
        prechatCapture?: PrechatCapture;
        type?: string;
    } & DefaultResponderReadable

    Type declaration

    • type: "web"
    • OptionalactionColor?: string

      This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color.

    • Optional ReadonlyattachmentsEnabled?: boolean

      Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.

    • OptionalbackgroundImageUrl?: string

      A background image url for the conversation. Image will be tiled to fit the window.

    • OptionalbrandColor?: 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.

    • OptionalbusinessIconUrl?: 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.

    • OptionalbusinessName?: string

      A custom business name for the Web Messenger.

    • OptionalbuttonHeight?: string

      With the button style Web Messenger, you have the option of specifying the button height.

    • OptionalbuttonIconUrl?: string | null

      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.

    • OptionalbuttonWidth?: string

      With the button style Web Messenger, you have the option of specifying the button width.

    • OptionalcanUserCreateMoreConversations?: boolean

      Allows users to create more than one conversation on the web messenger integration.

    • OptionalcanUserSeeConversationList?: 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.

    • OptionalconversationColor?: 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.

    • OptionaldisplayStyle?: string

      Choose how the messenger will appear on your website. Must be either button or tab.

    • OptionalfixedIntroPane?: boolean

      When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it.

    • OptionalintegrationOrder?: string[] | null

      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.

    • OptionaloriginWhitelist?: string[] | null

      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 "://" host [ ":" port ], where scheme is http or https.

    • OptionalprechatCapture?: PrechatCapture

      Object whose properties can be set to specify the add-on’s options. See the guide to learn more about Prechat Capture.

    • Optionaltype?: string

      To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint.

    Settings

    Member Visibility