Qwelp Support Sender API
    Preparing search index...

    Type Alias QwelpSettings

    Settings for a new QwelpSession.

    type QwelpSettings = {
        branding?: QwelpBranding;
        code?: string;
        customerKey?: string;
        fileTransfer?: boolean | FileTransferSettings;
        persistentMetaData?: MetaData;
        screenSharing?: boolean;
        secureMetaData?: MetaData;
    }
    Index
    branding? code? customerKey? fileTransfer? persistentMetaData? screenSharing? secureMetaData?
    branding?: QwelpBranding

    Customize the look (colors, logo, title) and support message of the sender-side UI dialogs.

    code?: string

    Use a predefined code for this, session. This is mainly for debugging.

    customerKey?: string

    A base64 encoded public ECDH key, with which the code will be encrypted.

    fileTransfer?: boolean | FileTransferSettings

    Allow sending files between customer and support agent by drag and drop (default: both directions). The receiving person always sees name and size and has to accept the file. false turns it off, an object switches each direction.

    persistentMetaData?: MetaData

    Key Value information that will be stored in plaintext with the session history

    screenSharing?: boolean

    Allow the support agent to request a screen share (default: true). The customer always has to agree and pick what to share - set it to false to never offer it on this site.

    secureMetaData?: MetaData

    Key Value information that will be transmitted to the receiver.

    Settings
    Member Visibility

    On This Page
    Properties