osTicket Integration

This guide will show you how to set up osTicket to work with your new Helpdesk Buttons.

Create Your API Keys

Once you are logged in as an Admin. Click on Admin Panel in the top-right.

../../../_images/os-image-1.png

Now click API Keys under the Manage tab.

../../../_images/os-image-2.png

We will need to create two API Keys. For each key, click Add New API Key and fill out the form

../../../_images/os-image-3.png ../../../_images/os-image-4.png

osTicket requires API Keys be paired with IP addresses. Helpdesk Buttons servers are located at:

  • 34.202.14.153
  • 3.209.57.193

Let’s Label these as Key1 (34.202.14.153) and Key2 (3.209.57.193)

Helpdeskbutton.com Settings

../../../_images/os-image-5.png

Once you have your API Keys and you put in the url for osTicket put the keys into the appropriate space on Settings page in this format:

Key1:Key2

That should be it. Hit update and test the integration with the Integration Test button.

Anti-Virus and AntiMalware

It is not always necessary, but we recommend whitelisting the helpdeskbuttons installation folder (C:\Program Files(x86)\Helpdesk Button). We regularly submit our code through VirusTotal to make sure we are not getting flagged, but almost all AV/M interactions cause some sort of failure. Webroot in particular can cause issues with screenshots.

Dispatcher Rules

This is the list of variables that can be accessed when using the Dispatcher Rules.

Read/Write Read Only
priority selections
alert name
auto_respond email
message hostname
subject mac
append ip

Field Definitions

priority

The ticket priority level (Urgent, Low, ect):
../../../_images/os-priority.png


alert & auto_respond

../../../_images/os-alert+auto.png


other

There are additional variables which are common to all integrations. Those are documented here