Channel center

HelpChat lets you configure channels that bring your organization's other systems into the client, with support for single sign-on and similar integrations.

1. What a channel is

A channel is a web page entry embedded in the client. Clicking it opens the configured URL inside the client. Use channels to integrate internal systems such as OA, CRM or a knowledge base, with single sign-on and one shared entry point.

2. Configure channels

Open the channel configuration page in the web admin console to add, edit and manage channels. Each channel has these settings:

Channel name, channel URL, channel icon, and the parameters and switches to include.

3. URL parameters

When a channel is clicked, the client sends the following parameters to the URL by GET or POST (each one can be turned on or off in the configuration):

ParameterDescription
UIDThe account's UID in the help_user table
UsernameThe account name the user signs in with
PasswordThe MD5 hash of the password
themeIncluded by default. Shows whether the client is using the dark or light theme, so the page can use matching colors

4. Relative URLs

If a channel URL starts with : or /, the client automatically prefixes it with the server address set at sign-in. For example:

text
Channel URL:     :6816/home
Server address:  192.168.111.76

Opened URL:      http://192.168.111.76:6816/home

Tip

This avoids hard-coding the server IP in channel settings, which makes moving the server easier.

5. Channel icons

Channel icon files must be in the public/channel/ directory on the server, in .png format. When configuring a channel, choose the icon file from the drop-down list.

6. Example pages

The server's public/channel/example/ directory contains basic post.php and get.php example pages. They show how to receive each parameter sent by the client and how to switch between dark and light page colors based on the theme parameter.

Info

These are basic examples. You can use these parameters to build full-featured channel pages that integrate closely with your organization's systems.