Repairshopr / Syncro Documentation¶
Setting up Helpdesk Buttons with Repairshopr or Syncro is easy and can be done in as few as 15 minutes.
Integration¶
Repairshopr / Syncro integration requires two 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¶
To start you will need to set up a contact that uses the email address of “unregistered@helpdeskbuttons.com” for the purposes of catching any unregistered users.
You can name the account whatever you want. In our system it’s “Mystery Human”.
This can be a customer or a contact under a customer.
Multiple Contacts per client¶
Note: This is no longer strictly necessary, but users will have to put in the email address of the customer instead of thier own address.
In case you don’t have contacts enabled and you want individuals to be able to put in tickets, this is how you do it:
Click Admin on the top bar
Click General Preferences on the left
Click Customer Settings and check the box labeled, enable multiple contacts on customers.
2) Get your API Key¶
Next you will need to create a Repairshopr or Syncro API key.
You can do this in the Admin Menu > API > API Tokens
Once you are there, click on the New Token button and Custom Permissions
Fill out the name as you like, and we recommend leaving the expiration blank to make a key that does not have to be recreated/renewed.
You will have to add the permissions of the key explicitly. The permissions the key will need are as follows:
API Access Settings¶
- Customers List/Search: For gathering company data like street addresses from companies
- Customers View Details: For gathering contact data like email addresses from contacts
- Ticket Comments - New: For adding public notes to tickets
- Tickets Create: For creating tickets
- Tickets Edit: For adding private notes
Keep in mind that this list is based on the current feature set. With the expansion of the product, different security settings may need to be tweaked in the future.
Once you have created the key copy it for the next step.
3) Helpdeskbuttons.com Settings¶
Once you have the API key, you will need to adjust your settings in the Helpdeskbutton website.
http://www.helpdeskbuttons.com
On the navigation bar on the left select Settings, then Backend Information.
And scroll down to the backend information part.
Select ‘RepairShopr / Syncro’ for the Ticket System
Enter the register URL that you use.
The Ticket System API endpoint is
example.repairshopr.com
Or the equivalent for Syncro. Be sure to omit the prefix (i.e. https://) and omit the suffix (i.e. /customers?api_key=)
Under Ticket System API Key, enter the API key that you used earlier. Once you have entered that information, click Update and it will save the information.
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 |
| status | name |
| comment_subject | |
| problem_type | business_name |
| message | hostname |
| subject | ip |
| append | mac |
| priv_append |
Field Definitions¶
Set Up a Webhook¶
To do this in Syncro/RepairShopr, go to Admin -> Notification Center
You will want to create a new Notification set.
Name it whatever you like and set the URL to the one on the Notification Page in the Helpdeskbutton portal.
Scroll through the list of events and enable webhooks for:
- Ticket : Someone replied to any ticket
- Ticket : Status was changed
Status changes already include creating a new ticket and resolving a ticket.
Make sure you save your changes.
