Setting up Connectwise Manage to work with Helpdesk Buttons is very easy. You will have to do some basic setup in your ConnectWise Manage system first though.
You will start off by logging into your ConnectWise Manage instance. The first step is to create a dummy company to catch tickets from unregistered users (If you already have a catch all that can submit tickets feel free to use that company). Fill out the required fields with your companies information and remember to click save. You might name the company “unregistered users” or something to that effect.
Once the company has been created, select Company Finance
Set the newly created company to ‘Active’ and click ‘Save’.
Create an ‘Unregistered’ contact This must have the email address email@example.com
This is the user which any Button Press tickets appear to come from if the user is unregistered. Remember to click save.
You are now done setting up your company and contact.
Get an API Key¶
Next step is to create an API key.
First you need your company name. This appears on the login screen.
Log into ConnectWise Manage and then select System and then Members
Select the ‘API Members’ tab.
Click on the ‘New’ button and set up the new API member
Enter a member ID and name which fits your organization. Select the appropriate System options according to how your ConnectWise Manage system is configured.
Take note of the Service Defaults as they can effect the way tickets come into the system.
Be sure to click ‘Save’ when everything looks correct.
Next, browse to the ‘API Keys’ tab.
Click ‘New’ and set an appropriate description.
Be sure to copy both the Public and Private Keys
Once this has been set up, you will have all the information required.
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 role will need to be created and assigned to us with these permissions):
- Companies/Company Maintenance/Inquire Level - All (For gathering company data like street addresses)
- Companies/Contacts/Inquire Level - All (For gathering contact data like email addresses)
- Service Desk/Service Ticket - Dependencies/ Add, Edit, Inquire Level - All (Adding/editing/reading notes and attachments on tickets)
- Service Desk/Service Ticket/ Add, Edit, Inquire Level - All (Adding/editing/reading tickets)
The group is based on your company, but it can be tricky. We recommend leaving this as Admin as it the integration will require access to view contact information based on the clients input. To avoid errors, your staff would need to make sure that no one puts in an email address that corresponds to a contact that is not covered by the group to which this API user belongs. To be clear, the permissions don’t need to be Admin, but the group does. This will allow us access to all of your customers, but only limited access to each.
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.
Advanced Integration Options¶
This is the list of variables that can be accessed when using the Custom Rules.
Note: State, Team and Type are all related to the Board. For any customizations to those fields do not use the “__default__” Board. Please provide the Board by name.