HelpSpot

https://support.helpspot.com
Admin
HelpSpot is a help desk and customer service ticketing software platform designed to manage support...
Tokens:483,286
Snippets:4,085
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and Start Apache and PHP

Source: https://support.helpspot.com/index.php?id=479&pg=kb.page

Installs the required web server and PHP modules, then enables and starts the Apache service.

```bash
# Install Apache + PHP
sudo yum install httpd php php-pdo php-mysql php-gd php-mcrypt php-curl php-imap php-xml

# Set Apache to start on boot:
sudo systemctl enable httpd.service

# Start Apache:
sudo service httpd start
```

--------------------------------

### Install HelpSpot via CLI

Source: https://support.helpspot.com/index.php?id=629&pg=kb.page

Guides through the installation process. Use flags to provide details for non-interactive installation.

```bash
# Interactive
php hs install


# Or prefill some or all options
php hs install --agree --name="Jane Doe" --admin-email="jane@example.com" --password="secret" ...and so on
```

--------------------------------

### Install and start Supervisor

Source: https://support.helpspot.com/index.php?id=685&pg=kb.page

Installs Supervisor and enables/starts the supervisord service.

```bash
sudo dnf install supervisor
sudo systemctl enable supervisord
sudo systemctl start supervisord
```

--------------------------------

### Install and start MySQL server

Source: https://support.helpspot.com/index.php?id=685&pg=kb.page

Installs MySQL server and enables/starts the mysqld service.

```bash
sudo dnf install mysql-server
sudo systemctl enable mysqld
sudo systemctl start mysqld
```

--------------------------------

### Run HelpSpot interactive installation

Source: https://support.helpspot.com/index.php?id=468&pg=kb.page

Execute the installation command to start an interactive prompt for required configuration details.

```bash
php hs install
```

--------------------------------

### View HelpSpot installation help

Source: https://support.helpspot.com/index.php?id=468&pg=kb.page

Run the help command to display all available flags and options for the installation process.

```bash
php hs install -h
```

--------------------------------

### Create .env Configuration File

Source: https://support.helpspot.com/index.php?id=642&pg=kb.page

Navigate to the HelpSpot directory and create the .env file from the provided example.

```bash
cd /var/www/helpspot
cp .env.example .env
```

--------------------------------

### HelpSpot Installation Commands

Source: https://support.helpspot.com/index.php?id=655&pg=kb.page

Use these commands to view installation options or initiate the interactive installation process.

```bash
# Get the help menu to see available options
php hs install -h

# Run the installer interactively
php hs install
```

--------------------------------

### Install Redis Server on Ubuntu

Source: https://support.helpspot.com/index.php?id=717&pg=kb.page

Updates package lists and installs the Redis server package from the default Ubuntu repositories. After installation, Redis is automatically started.

```bash
# Update package lists
sudo apt-get update

# Install Redis server
sudo apt-get install -y redis-server

```

--------------------------------

### HelpSpot .env configuration example

Source: https://support.helpspot.com/index.php?id=620&pg=kb.page

Example .env file with common settings: APP_DEBUG, APP_URL, database connection (mysql), and QUEUE_CONNECTION. Comments explain each setting.

```plaintext
## Enable debugging output in the web front end
APP_DEBUG=false
## The base url of the HelpSpot application (without a trailing slash)
APP_URL=https://example.org

## Database type mysql or mssql
DB_CONNECTION=mysql
## The DNS name or IP of the database server
DB_HOST=localhost
## The port for the database server
DB_PORT=3306
## The database name for the helpspot database
DB_DATABASE=helpspot
## The database user name
DB_USERNAME=some_user
## The database user password
DB_PASSWORD=some_pass

## The selected queue driver. Database is default.
QUEUE_CONNECTION=database

```

--------------------------------

### request.getCategories API Example

Source: https://support.helpspot.com/index.php?id=6&pg=kb.printer.friendly

Retrieves a list of all public categories using GET.

```bash
curl http://.../api/index.php?method=request.getCategories
```

```xml
<?xml version="1.0" encoding="iso-8859-1"?>
<categories>
        <category>
                <xCategory>3</xCategory>
                <sCategory>Usage Question</sCategory>
                <sCustomFieldList>
                        <xCustomField>7</xCustomField>
                        <xCustomField>5</xCustomField>
                        <xCustomField>11</xCustomField>
                        <xCustomField>9</xCustomField>
                        <xCustomField>2</xCustomField>
                </sCustomFieldList>
        </category>
        <category>
                <xCategory>1</xCategory>
                <sCategory>Report a Bug</sCategory>
                <sCustomFieldList>
                        <xCustomField>2</xCustomField>
```

--------------------------------

### Set APP_URL for secure subdomain

Source: https://support.helpspot.com/index.php?id=658&pg=kb.page

Use this example when your HelpSpot installation is hosted on a secure subdomain. The APP_URL must be in standard HTTP URL format and resolve to the public folder of your installation.

```plaintext
APP_URL=https://helpspot.company.com
```

--------------------------------

### private.customer.setPasswordByEmail Example

Source: https://support.helpspot.com/index.php?id=6&pg=kb.printer.friendly

Demonstrates how to set a portal password for an email account using a GET request.

```bash
curl -u tim@ex.com:mypassword "http://.../api/index.php?method=private.customer.setPasswordByEmail&sEmail=tsmith@companyco.com&sPassword=8!TrucK"
```

```xml
<?xml version="1.0" encoding="iso-8859-1"?>
<results>
    <sPassword>8!TrucK</sPassword>
</results>
```

--------------------------------

### Complete HelpSpot Widget Tab Configuration Example

Source: https://support.helpspot.com/index.php?id=323&pg=kb.page

Complete example showing every configuration option for the HelpSpot widget tab. Includes customization for alignment, tab type, colors, text labels, and error messages. The onLoad and onClose callbacks are commented out.

```html
<style type="text/css">@import url('http://www.YOURDOMAIN.com/helpdesk/widgets/widgets.css');</style>
<script type="text/javascript" src="http://www.YOURDOMAIN.com/helpdesk/widgets/widgets.js"></script>
<script type="text/javascript">
HelpSpotWidget.Tab.show({ 
	host: 'http://www.YOURDOMAIN.com/helpdesk',
	alignment: 'left',
	tabtype: 'questions',
	tabtype_custom_img: '',
	top: '30%',
	width: 600, 
	color: 'white',
	background_color: '#222222',
	hover_color: '#222222',
	popup_background_color: '#fff',
	popup_border_color: '#ccc',
	popup_border_size: '10px',
	overlay_color: '#000',
	default_note: '',
	default_name: '',
	default_email: '',
	use_field_name: true,
	text_header: 'How can we help?',
	text_intro: 'Submit your question/comment for a member of our team.',
	text_note: 'Question',
	text_note_er: 'Please provide some information on your request',
	text_email: 'Your Email',
	text_email_er: 'Please provide your email address',
	text_name: 'Your Name',
	text_name_er: 'Please provide your name',
	text_submit: 'Submit',
	text_msg_submit: 'Message sent, thank you.',
	text_msg_submit_error: 'Sorry, there was an error.',
	text_msg_submit_error_link: 'Please try this form',
	text_msg_submit_error_url: 'http://www.YOURDOMAIN.com/helpdesk',
	text_loading: 'Loading...',
	text_special: ''
	//,onLoad: function(){ alert('open'); },
	//onClose: function(){ alert('close'); }
});
</script>
```

--------------------------------

### Set APP_URL to IP address

Source: https://support.helpspot.com/index.php?id=658&pg=kb.page

Use this example when your HelpSpot installation is accessed via an IP address. The APP_URL must be in standard HTTP URL format and resolve to the public folder of your installation.

```plaintext
APP_URL=http://192.168.0.1
```

--------------------------------

### Install prerequisites (mysql-server, nginx, supervisor, unzip)

Source: https://support.helpspot.com/index.php?id=642&pg=kb.page

Installs the core packages HelpSpot needs. If using an external MySQL database, you can skip installing mysql-server.

```bash
sudo apt-get install -y mysql-server nginx supervisor unzip
```

--------------------------------

### Set APP_URL with port

Source: https://support.helpspot.com/index.php?id=658&pg=kb.page

Use this example when your HelpSpot installation is accessible via an internal hostname with a custom port. The APP_URL must be in standard HTTP URL format and resolve to the public folder of your installation.

```plaintext
APP_URL=http://myinternalapp:8080
```

--------------------------------

### Install HelpSpot via Command Line

Source: https://support.helpspot.com/index.php?id=16&pg=kb.printer.friendly

Run the HelpSpot installer interactively or with options. Use 'php hs install -h' to see available options. The installer will prompt for details, including the license file path.

```bash
# Get the help menu to see available options
php hs install -h

# Run the installer interactively
php hs install

```

--------------------------------

### Get Saved Report via private.report.getSaved

Source: https://support.helpspot.com/index.php?id=6&pg=kb.printer.friendly

Example of retrieving report data using basic authentication.

```bash
curl -u tim@ex.com:mypassword "http://.../api/index.php?method=private.filter.getSaved&xReport=12"
```

```xml
<?xml version="1.0" encoding="UTF-8"?>
<report>
    <metadata>
        <report_name>Comparison Matrix API Test</report_name>
        <date_range>
            <from>1754024400</from>
            <to>1756357200</to>
        </date_range>
    </metadata>
    <data>
        <x_axis_totals>
            <item_0>
                <label>August, 2025</label>
                <value>4</value>
            </item_0>
        </x_axis_totals>
        <y_axis_totals>
            <item_0>
                <label>Active</label>
                <value>4</value>
            </item_0>
            <item_1>
                <label>Status A</label>
                <value>0</value>
            </item_1>
            <item_2>
                <label>Status A</label>
                <value>0</value>
            </item_2>
            <item_3>
                <label>Status A</label>
                <value>0</value>
            </item_3>
            <item_4>
                <label>Status A</label>
                <value>0</value>
            </item_4>
            <item_5>
                <label>Status B</label>
                <value>0</value>
            </item_5>
        </y_axis_totals>
        <x_axis_type>Open Date: Month</x_axis_type>
        <y_axis_type>Status</y_axis_type>
        <datapoints>
            <item_0>
                <x_axis_label>August, 2025</x_axis_label>
                <y_axis_label>Active</y_axis_label>
                <value>4</value>
            </item_0>
            <item_1>
                <x_axis_label>August, 2025</x_axis_label>
                <y_axis_label>Status A</y_axis_label>
                <value>0</value>
            </item_1>
        </datapoints>
    </data>
</report>
```

--------------------------------

### Install HelpSpot

Source: https://support.helpspot.com/index.php?id=641&pg=kb.page

Downloads, extracts, configures, and installs HelpSpot, including setting file ownership and SELinux contexts.

```bash
cd ~/
curl -o helpspot.zip https://s3.amazonaws.com/helpspot-downloads/5.5.10/helpspot.zip

sudo mv helpspot.zip /var/www
cd /var/www

sudo unzip -q helpspot.zip
sudo mv helpspot_5.5.10 helpspot

cd helpspot
sudo cp .env.example .env

# Update .env file.  
# Enter you database username and password setup previously and the APP URL. The app key will be created automatically during installation.
sudo vim .env

# Change owner of files
sudo chown -R nginx:nginx /var/www/helpspot
sudo chcon -Rv --user=system_u --role=object_r --type=httpd_sys_content_t /var/www/helpspot
sudo chcon -Rv --type=httpd_sys_content_rw_t /var/www/helpspot/bootstrap
sudo chcon -Rv --type=httpd_sys_content_rw_t /var/www/helpspot/storage

  
# Download your helpspot license file and place it in /var/www/helpspot/ so that it can be easily referenced during the install process.  

sudo -u nginx php hs install

```

--------------------------------

### customer.getRequests API Example

Source: https://support.helpspot.com/index.php?id=6&pg=kb.printer.friendly

Retrieves all requests for a customer using GET. Requires sEmail and sPassword parameters.

```bash
curl "http://.../api/index.php?method=customer.getRequests&sEmail=tsmith@companyco.com&sPassword=nusoxdln"
```

```xml
<?xml version="1.0" encoding="iso-8859-1"?>
<requests>
    <request>
        <xRequest>12489</xRequest>
        <fOpenedVia>2</fOpenedVia>
        <xOpenedViaId>0</xOpenedViaId>
        <fOpen>1</fOpen>
        <xStatus>1</xStatus>
        <fUrgent>0</fUrgent>
        <xCategory>2</xCategory>
        <dtGMTOpened>1212776831</dtGMTOpened>
        <sRequestPassword>jiicxp</sRequestPassword>
        <sTitle>RE: Information on Your Request</sTitle>
        <sUserId />
        <sFirstName>Tim</sFirstName>
        <sLastName>Smith</sLastName>
        <sEmail>tsmith@companyco.com</sEmail>
        <sPhone />
        <sCategory>Account Inquiries</sCategory>
        <sStatus>Active</sStatus>
        <tNote>I am looking for information on my account.</tNote>
        <fullname>Tim Smith</fullname>
        <accesskey>12489jiicxp</accesskey>
    </request>
</requests>
```

--------------------------------

### HelpSpot .env Configuration File

Source: https://support.helpspot.com/index.php?id=655&pg=kb.page

The .env file contains essential application and database connection settings. Copy the provided .env.example file to create this configuration.

```text
APP_DEBUG=false
APP_URL=https://example.org
APP_KEY=

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=helpspot
DB_USERNAME=some_user
DB_PASSWORD=some_pass

QUEUE_CONNECTION=database
```
Tokens:
Raw