<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Kaseya VSA X Integration?</strong></p><p><strong>- Connecting to Kaseya VSA X</strong></p><p><strong>- Customer Imports</strong></p><p><strong>- Asset Imports</strong></p><p><strong>- Alert Webhooks</strong></p><p><strong>- Syncing with the Halo Integrator</strong></p><p><br></p><p><br></p><p><strong>Related Guides:</strong></p><ul style="list-style-type: disc;"><li style="font-weight: bold;"><a href="https://usehalo.com/halopsa/guides/1494" target="_blank" rel="noopener noreferrer"><strong>Kaseya VSA Integration</strong></a></li></ul><p><br></p><p><br></p><p id="isPasted"><strong><span style="font-size: 14pt;">What is the Kaseya VSA X Integration?</span></strong></p><p>Kaseya VSA X can be integrated with Halo to import Customers and their Assets, as well as generate Alert Tickets when a notification is received from VSA X. This is a multi-tenanted integration, so multiple VSA X connections can be created.</p><p><br></p><p><strong><em>Note: If using the original Kaseya VSA platform, check out the "<a href="https://usehalo.com/halopsa/guides/1494" target="_blank" rel="noopener noreferrer"><strong>Kaseya VSA Integration</strong></a>". This Kaseya VSA X integration is a newer, separate version.</em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Kaseya VSA X</span></strong></p><p>Within the VSA X WebApp, navigate to Configuration > API Access. Here you will find a list of Third-Party Tokens if some already exist. Click "Create Token".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0MWJlZjhiLTNhYjYtNDQ3NS1hNmM1LWU5ZWNkOWFkOTFjNSJ9.dgpwf9GbHH-297Swf09hxPr2QAEpyNkYUSLKeJUYgkQ" class="fr-fic fr-fil fr-dib" width="1217" style="width: 1219px; height: 576.752px;" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 1. API Access area in VSA X.</span></strong></p><p><br></p><p>This will bring up a screen to create your Token. Give it a relevant name/description, then set a start date (required) and an end date (optional).</p><p><br></p><p>Click "Next".</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU0NTczYWEyLWVlYTctNDQzMi1hMWZiLWI1NWQ5YTUwNmIzZiJ9.tV3SE3QeM3i5-Tfqce13RahEhx6_Oggx8DEM1yXCMVs" class="fr-fic fr-fil fr-dib" width="1223" style="width: 1225px; height: 579.487px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 2. Setting the token details.</span></strong></p><p><br></p><p>On the screen that follows, you can set authorisation restrictions for the token. Set the "Permissions" here to all, and save.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjliZWQwZWI5LWY2Y2MtNDc5NS1iMzVmLTgyZDgxZWNkMGZjNCJ9.9WTsF7nTNhlHJGkDvQvOPIaknCjyJZq7TPHJ2Dwbleo" class="fr-fic fr-fil fr-dib" width="1223" style="width: 1225px; height: 578.579px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 3. Granting token permissions.</span></strong></p><p><br></p><p>A popup will then show with the Token ID and Token Secret. Take note of both of these values, especially the Token Secret as you will not be able to access this again after exiting the popup.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIxMjVjMmY5LTMyMzMtNDAwZC05YTRlLTQ4MGI1ZjE3OTJmZiJ9.xirlOkoId1cXlDVjXA6s5wAsJt7pDj5OAjebX0SzvSI" class="fr-fic fr-fil fr-dib" width="528" height="586"></p><p><strong><span style="font-size: 10pt;">Fig 4. Generated Token ID and Token Secret.</span></strong></p><p><br></p><p>Now, head back to Halo where we will enter these details to connect to VSA X. In Configuration > Integrations, hover over the Kaseya VSA X module, and click the "+" icon to enable it.</p><p><br></p><p>Then click into the module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjkwZTJlMTkwLTE4ZWEtNDllNy1iNmUyLTFjYTFlOTI4N2Y5NiJ9.1xOe_bJyiPsxg4YhTBw-s_8RLobVYczDtB8LGaWDmNY" class="fr-fic fr-fil fr-dib" width="342" height="144"></p><p><strong><span style="font-size: 10pt;">Fig 5. Enabling the Kaseya VSA X module.</span></strong></p><p><br></p><p>If any connections have been made to Kaseya VSA X previously, a list of these will appear here. Click the "New" button in the top right corner to add a new connection.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjYjEzODQyLWVmNWItNDAyYi05MjgyLThjODJjY2E1MDg4MyJ9.-bQEpD-YC0hWQCSyO9EXLRo9n1JwS8xoESJ0E5l37E4" class="fr-fic fr-fil fr-dib" width="1221" style="width: 1223px; height: 116.14px;" height="116"></p><p><strong><span style="font-size: 10pt;">Fig 6. List of VSA X connections.</span></strong></p><p><br></p><p>The screen that shows first will allow you to enter the details we generated in the VSA X WebApp. Give the connection a relevant name.</p><p><br></p><p>Then you will enter the Token ID and Token Secret from the token generation, alongside the URL of your VSA X instance.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVhMTc3ZmNkLTMzODAtNDg3Ny04NDM1LTFhOWY3ODQ0NTMzMCJ9.ZDwBsZVtHgQdXAIfsbrfLOyHTeOOOwUSSfrin1zkG5A" class="fr-fic fr-fil fr-dib" width="1024" height="402"></p><p><strong><span style="font-size: 10pt;">Fig 7. Entering the connection details.</span></strong></p><p><br></p><p>Upon saving, a button to "Test Configuration" will show.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjExMDc3NzAwLTdkMDQtNDhlMi1iNTRiLWUxNDMwZTJiNjM5OSJ9.LlbytF_m-QZE6rg8HWlUjmprQZDLRdSm0y1R7v-Uj_Q" class="fr-fic fr-fil fr-dib" width="865" height="376"></p><p><strong><span style="font-size: 10pt;">Fig 8. Test Configuration button.</span></strong></p><p><br></p><p>After a short loading period, a popup will show to determine if the credentials provided are correct. If you see the below popup message, you can move on to the imports. </p><p><br></p><p>If any issues arise, an error message will be provided to help troubleshoot this.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhiMTk5NGZjLTM0NTktNDBhNi1iYTdhLWFjMTY3NjNmOWYzZSJ9.rDrWbYHUEbRrGMQyjBwxn5D0ctOl-t5tbxQJDqkzUJE" class="fr-fic fr-fil fr-dib" width="165" height="115"></p><p><strong><span style="font-size: 10pt;">Fig 9. Test successful popup.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Customer Imports</span></strong></p><p>Switch to the "Customers" tab. Here we will configure the mappings to import and match VSA X Organisations/Sites to Halo Customers/Sites. </p><p><br></p><p>The first field sets the "Site matching method". We will cover how both function, starting with Site mappings. With this method, you will map a Halo Customer/Site to a VSA X Organisation/Site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjMyZmRkMzE1LTIxY2UtNDg2Yi04NTJjLTA1ZjgyZTk5OWM5MiJ9.1Rpj9KpMCGnbZe5rU6zJWMHi1mCyugdO2kjSLO17yr0" class="fr-fic fr-fil fr-dib" width="1214" style="width: 1216px; height: 305.36px;" height="305"></p><p><strong><span style="font-size: 10pt;">Fig 10. Site mappings matching method configuration.</span></strong></p><p><br></p><p>Clicking the "Add" button on the "Customer Mappings" table allows you to set these mappings. You will first map a Halo Customer to a VSA X Organisation, then after a Halo Site within that Customer to a VSA X Site.</p><p><br></p><p>Using this method, any Organisations that have not been mapped will create a new Customer upon import, and these mappings will be automatically added into the "Customer Mappings" table for future imports.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM0NTY5MjQ0LTBiYzgtNDhhNS1iNDdiLTNjYWViMDdiMGUyMyJ9.z2Pm80F7PvZ_Y7MfDGycSNVva-VNL_fZx-dXP5pRLko" class="fr-fic fr-fil fr-dib" width="710" height="483"></p><p><strong><span style="font-size: 10pt;">Fig 11. Customer/Site mappings popup.</span></strong></p><p><br></p><p>The second "Site matching method" is using Site Rules. These use Field criteria to determine which VSA X Organisation/Site matches to a Halo Customer/Site.</p><p><br></p><p id="isPasted"><strong><em>Note: Criteria is based on Halo fields, so any fields set here will need to be mapped in the following "Assets" tab.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhhN2I0ZmU1LTM5ZTctNGI2OC05YzUyLTYxNThjYTAxYmZlMCJ9.vN531YeEpeNuPc3rHYyadWaBbpSrFuUHkMZSi3rcOtQ" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 310.212px;" height="310"></p><p><span style="font-size: 10pt;"><strong>Fig 12. Site rules matching method configuration.</strong></span></p><p><br></p><p>Clicking the "Add" button on the "Site Rules" table will show the following popup. Select a Customer/Site, and a sequence for what order these rules are followed in. The lower the sequence number, the higher the order of the rule.</p><p><br></p><p>You will then set the criteria for the rule. In this example, any imports where the "Name" field in Halo starts with "HAL" will be mapped to the "Halo House" Site.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM4NTM0MjU0LTA0ZDctNDJlOS04ODM4LWE3M2ZkYTI2NWIwOSJ9.11viIis4VfbdjtFM8nMJhyd13aE8DSQqTiOQhbaRdXI" class="fr-fic fr-fil fr-dib" width="711" height="538"></p><p><strong><span style="font-size: 10pt;">Fig 13. Customer/Site rule popup.</span></strong></p><p><br></p><p>Once your Customers and Sites are mapped by whichever method you choose, some additional configuration can be set. </p><p><br></p><ul><li><strong>Top Level for New Customers:</strong> If Top Levels are enabled in Configuration > Users > General Settings, new Customers can be added to the Top Level set here upon creation.</li><li><strong>Assets will be assigned to this Site if no Site has been matched:</strong> The default Site an Asset is assigned to if the mappings/rules do not match any Site.</li><li><strong>Don't update the asset site for existing or matched assets:</strong> If enabled and a Halo Site an Asset is against is different than what the VSA X Site is mapped to, the Asset will not be moved Halo Sites.</li></ul><p><br></p><p>Save, and the buttons to "Import Customers" and "Import Sites" will then show. Import your Customers first, then your Sites.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU2NTFiZjNlLTVlNWMtNGY0Yy05M2FiLTMwN2IyNDY3YWJkNSJ9.Id3ngI6Y2VdKbzQW3zRAtOyQ-rsDxxgXMGd8fKkUSh8" class="fr-fic fr-fil fr-dib" width="393" height="338"></p><p><strong><span style="font-size: 10pt;">Fig 14. Miscellaneous Customer configuration and import buttons.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Asset Imports</span></strong></p><p>Once your Customers are imported, switch to the "Assets" tab.</p><p><br></p><p>First, set the "Asset Matching Field". This is the Field that will be used to match Assets when importing. If a match is found, the existing Asset will be updated. If no match is found, a new Asset will be created. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVjODllMTZkLTE2YjMtNDI2OS1iM2E2LTZjNTBjNmVmZTJmOSJ9.IMqvIapZODQaPGNUqm0SNLw_HOlnnCxCEgbxrCjjB8M" class="fr-fic fr-fil fr-dib" width="1219" style="width: 1221px; height: 343.944px;" height="344"></p><p><strong><span style="font-size: 10pt;">Fig 15. Asset Imports configuration.</span></strong></p><p><br></p><p>Click the "Add" button to add mappings between VSA X and Halo Fields. These mappings can be to Asset Fields or Custom Fields with the "Asset" entity. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlMGFkOGI3LWUyY2EtNDFmZS1hZTU1LTA0YzI1NmUxZjc1MiJ9.foXNuz6cr37IPSiuXqNIFQaWW4vhMegTa1eRY67w2A8" class="fr-fic fr-fil fr-dib" width="707" height="410"></p><p><strong><span style="font-size: 10pt;">Fig 16. Field mapping popup.</span></strong></p><p><br></p><p>After setting each mapping, scroll down to configure the Asset Types. </p><p><br></p><ul><li id="isPasted"><strong>Default Group for new Asset Types: </strong>Sets the Asset Group newly created Asset Types will be assigned to.</li><li id="isPasted"><strong>Determining an Asset's type:</strong>Sets how the Asset Type is determined. <ul style="list-style-type: disc;"><li id="isPasted"><strong>Use the same type for all Assets:</strong> Assigns all Assets to a set Asset Type.</li><li id="isPasted"><strong>Use a field to determine each Asset's type:</strong> A set Field will be used for determining an Asset's type. If an Asset cannot match via this Field, it will be assigned to a set default Asset Type.</li><li id="isPasted"><strong>Determine Asset Type using rules: </strong>Criteria can be mapped to Asset Types based on values in Halo Fields. If an Asset cannot match via this Field, it will be assigned to a set default Asset Type.</li></ul></li><li id="isPasted"><strong>Don't update the Asset type for existing or matched Assets:</strong> If enabled, pre-existing Assets will not have their Asset Type updated (if different in VSA X).</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ2MWNlZTk1LTRhMGMtNGUzYS1iMGJjLTJiM2I3MDkxZTc3MyJ9.YnfmTjAZEwcQANeCteN6arjYOpfxnTCq_8_75F2N-mc" class="fr-fic fr-fil fr-dib" width="774" height="577"></p><p><strong><span style="font-size: 10pt;">Fig 17. Asset Type configuration.</span></strong></p><p><br></p><p id="isPasted">Finally, we can set the miscellaneous Asset configuration.</p><p><br></p><ul style="list-style-type: disc;"><li><strong>Don't create new Assets:</strong> If enabled, Assets will not be created, only updated.</li><li><strong>Status of New Assets:</strong> Newly created Assets will be given this Status.</li><li><strong>Deactivate Assets in Halo when they are deleted from Kaseya VSA X (Halo Integrator only):</strong> If Assets are deleted in Kaseya VSA X, they will be made inactive in Halo (via the "Active" checkbox) when syncing via the Halo Integrator.</li><li><strong>Status for Assets when they are deleted from Kaseya VSA X (Halo Integrator only):</strong> If Assets are deleted in VSA X, they will be given this Status in Halo when syncing via the Halo Integrator.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFlZjA1ZWE4LTAwYWYtNDZiMC05Y2E3LTdlYzBhYzY4N2U0ZCJ9.vd98sw5vtv5AmPt4pLVdBmpHgZRuM2drnmo5KnJuTXw" class="fr-fic fr-fil fr-dib" width="581" height="439"></p><p><strong><span style="font-size: 10pt;">Fig 18. Miscellaneous Asset configuration and import button.</span></strong></p><p><br></p><p id="isPasted">The Assets below have been imported, created a new "restapi" Asset Type, and assigned the Assets to that Asset Type. The newly created Asset Type has been assigned to the default Asset Group set in <strong>Fig 17</strong>.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjlhNWYwMzAzLTFhNzktNDczNy05NzRjLTdlZWYxNmRiZjZiNSJ9.yJq2xBI9vGkldjwV0zzHDC9Y87THZ79-zQMo0yqj2NA" class="fr-fic fr-fil fr-dib" width="1224" style="width: 1226px; height: 486.059px;" height="486"></p><p><strong><span style="font-size: 10pt;">Fig 19. Imported Assets with newly created Asset Type.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Alert Webhooks</span></strong></p><p>After both imports are complete, you can enable Alerts to log Tickets in Halo via a webhook from Kaseya VSA X.</p><p><br></p><p>Click "Enable alert processing" to allow and configure this. A button to "Create Webhook" will then show underneath. Clicking this button will create a webhook in Kaseya VSA X that will be triggered from notifications.</p><p><br></p><ul><li><strong>Associate related assets with new Tickets: </strong>If the Asset associated with the notification is found in Halo, then it will be linked to the Ticket in the "Asset" Field.</li><li><strong>T</strong><strong>icket Type for New Tickets:</strong> Sets the Ticket Type that will be logged when the webhook is triggered. <em><strong>Note: This Ticket Type must have no mandatory fields.</strong></em></li><li><strong>User for New Tickets:</strong> Sets the End-User of the Tickets that are logged from alerts.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3MmQzZDA1LTc5YTAtNDVlNS1hMDJhLWY4YTg0ZTNhMzJhYyJ9._JoRZ2IhJV8PYj1Kn93VWKtCj7-FuGFwFgGskREQkOg" class="fr-fic fr-fil fr-dib" width="809" height="617"></p><p><strong><span style="font-size: 10pt;">Fig 20. Alert configuration.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Syncing with the Halo Integrator</span></strong></p><p id="isPasted">Once Customers/Sites and Assets are configured, you can enable the Halo Integrator to automatically sync these.</p><p><br></p><p><em><strong>Note: It is recommended to ensure you are happy with the configuration by manually importing before enabling automatic syncs via the Integrator.</strong></em></p><p><br></p><p>Check "Enable the Halo Integrator for the Kaseya VSA X integration", and select the entities you wish to automatically sync.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ1Nzc3ZmZmLTBmYzYtNGIyZC1hNWNjLTg5MDkwNzY1MzJkMSJ9.xwe5flmAHVEz24TUpGzjaoF6NflGwXTlHcEJpCoIo7w" class="fr-fic fr-fil fr-dib" width="998" height="362"></p><p><strong><span style="font-size: 10pt;">Fig 21. Halo Integrator configuration.</span></strong></p><p><br></p>
