Kaseya BMS Documentation

This guide will show you how to set up your new Helpdesk Buttons with Kaseya BMS in as few as 15 minutes.


Kaseya integration requires three main parts:

1) set up an unregistered user as a catchall account as a contact in your PSA

2) set up the API integration.

3) configure helpdeskbuttons account.

Video Walkthrough

1) Unregistered User

First we need to make a contact in a catch all company, this contact will put tickets in on behalf of users that are not currently in the system.


This is our contact. Feel free to use whatever data you would like, but make sure the email address is unregistered@helpdeskbuttons.com

2) Create an API User

Navigate to the Employee window:

../../../_images/ka-image1.png ../../../_images/ka-image2.png

It is probably best to create a new user, but an existing user with the correct permissions can work. This guide will assume you create a new user.

Click New and create the user with whatever data you may like. The Security Role is the only important part of this process. To start out put it as Administrator. You will need the email address to be something that can receive the password. Once that is complete an email will be sent to the address specified with the login credentials we need.

3) Helpdeskbutton.com Settings

Once we have that email, plug the info into the Settings page after selecting Kaseya BMS as the Ticket System. The format is:


The company name we need is the one used to identify your account.


Note: keep spaces in the company name and some punctuation may need to be replaced by spaces. Some people have needed to remove capitalization.

Here is what our apikey looks like for our test instance:


Once you click update you should be good to go.

Integration Defaults

Kaseya requires a lot of information to submit a ticket. We have chosen some defaults that will allow tickets to go into the system for most users.

Please note that either queue, assignee, or both must be set for this integration to work properly.

API Access Settings

For those of you who want to restrict the access the API user has, here is the security access we need: (a custom security role will need to be created and assigned to us with these permissions):

  • Service Desk/My Tickets: View and Modify - For Creating and editing tickets
  • Service Desk/Tickets: View and Modify - For Creating and editing tickets
  • Service Desk/Unknown Tickets: View and Modify - For Creating and editing tickets
  • CRM/Accounts View - For gathering location data (addresses)
  • CRM/Contacts View - For Matching tickets with contacts
  • Admin/Special Features: Has API Access - To access the API

Anti-Virus and AntiMalware

It is not always necessary, but we recommend whitelisting the tier2tickets installation folder (C:\Program Files(x86)\tier2tickets). 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
ticketStatus name
queue email
ticketType ip
msg openDate
title hostname
ticketSource mac

Field Definitions


The ticket priority level (Urgent, Low, etc.):


The ticket status (New, In Progress, etc):


A short description of the ticket issue:


The issue type in Kaseya (Helpdesk, Internal, etc):


The queue the ticket will be assigned to:


The agent the ticket will be assigned to:


The source of the ticket (Client portal, Phone, Other):


Allows you to append information to the internal ticket note:


The date the ticket was created:


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

Webhook Walkthrough

Kaseya BMS does not support webhooks. We are looking into another system for enabling notifications for this ticket system.