Browse Guides

Site24x7 Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<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 Site24x7 Integration?</strong></p><p><strong>- Creating the Site24x7 Webhook</strong></p><p><strong>- Creating Alert Tickets</strong></p><p><strong>- Asset Matching</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is the Site24x7 Integration?<br></span></strong></p><p>The Site24x7 integration can be used to automatically create alert tickets in Halo when services are considered down in Site24x7.</p><p><br></p><p><strong><em>Note: Site24x7 also has&nbsp;</em></strong><a href="https://www.site24x7.com/help/admin/third-party-integration/webhooks.html" target="_blank" rel="noopener noreferrer"><strong><em>this guide</em></strong></a><strong><em>&nbsp;on configuring third-party URLs, which may also be helpful during the setup.</em></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating the Site24x7</span></strong><span style="font-size: 14pt;"><strong>&nbsp;Webhook</strong></span></p><p>First, enable the integration in Halo. Go to Configuration &gt; Integrations &gt; Asset Management and Alerting, hover over the &quot;Site24x7&quot; module, and click the &quot;plus&quot; (+) icon to enable it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjlhNzRlM2UyLTMzYmQtNDJiZS04NzQ2LTQ2ZjExMTc4ODk1ZCJ9.2UnSzSZmrx446M7vNkfUec713ibGbgWAn8jcG2JsQNk" class="fr-fic fr-fil fr-dib" width="98" height="111"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the module.</span></strong></p><p><br></p><p>Clicking into the module will then bring you to this page. The three fields at the top (&quot;URL&quot;, &quot;Username&quot; and &quot;Password&quot; are what we will use to configure the webhook in Site24x7.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhMzU2NTUzLTVhMGMtNDI2ZC04OGIwLTc5YTNiZDdlYjg4MCJ9.g5wRyE3hDhwN9m1Ja9vQylJBu6CTytiUPXSV0jB3h6I" class="fr-fic fr-fil fr-dib" width="1237" style="width: 1239px; height: 584.886px;" height="585"></p><p><strong><span style="font-size: 10pt;">Fig 2. Site24x7 setup.</span></strong></p><p><br></p><p>In Site24x7, go to &quot;Admin&quot; &gt; &quot;Third-Party Integrations&quot; &gt; &quot;Add Third-Party Integration&quot; &gt; &quot;Webhooks&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImViYWMzZTQzLTRjYjYtNDE0NS04MWQ5LTQ3YTdhNWVlYjhlNCJ9.NM5h6H-HDNOX4KLSDz_1-Ws5r7K88gv02Kb2Toyte-A" class="fr-fic fr-fil fr-dib" width="1232" style="width: 1234px; height: 581.503px;" height="582"></p><p><strong><span style="font-size: 10pt;">Fig 3. Going to create a webhook in Site24x7.</span></strong></p><p><br></p><p>You will then be able to configure your webhook.</p><p><br></p><p>1) Name your webhook so you can easily identify it is for Halo.</p><p>2) Enter the URL from <strong>Fig 2</strong> into the &quot;Hook URL&quot; box. <strong><em>Note: If Site24x7 says this is an invalid URL, try typing manually instead of copy/paste.</em></strong></p><p>3) Set the HTTP Method as &quot;POST&quot;.</p><p>4) Enable the &quot;Post as JSON&quot; checkbox.</p><p>5) Set your accessibility to &quot;Global&quot;.</p><p>6) Enter the Username from <strong>Fig 2</strong> into the &quot;User Name&quot; box.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg4ODM3NWUyLWU2ZmMtNGM1Zi1hYzBlLTIyMWMyYmI5NTZkMyJ9.fbvIRjgezgPgPvtfhz_7wGKhDiIweTzgN7-lRoIrfwM" class="fr-fic fr-fil fr-dib" width="1238" style="width: 1240px; height: 584.636px;" height="585"></p><p><strong><span style="font-size: 10pt;">Fig 4. Creating the webhook.</span></strong></p><p><br></p><p><strong><em>Note: If using the MSP flavour, enable &quot;Send Custom Parameters&quot; and add {&quot;Customer&quot;:&quot;$MSP_CUSTOMER_NAME&quot;} to the textbox.</em></strong></p><p><br></p><p>You will need to go back into Halo to generate the password for the password field underneath the username.</p><p><br></p><p><strong><em>Note: Keep both Site24x7 and Halo open in a tab each when configuring this.</em></strong></p><p><br></p><p>Click the &quot;Generate&quot; button in the Site24x7 module to generate a password. One will then appear where you can then click the &quot;Copy&quot; button that appears to copy it to your clipboard.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRiMDhmYThhLTBiYjQtNDc1OS05MjQxLWVlODFkMmQzNGU3YyJ9.YouoeeUsux2GJ-c1XK0CWvjA6-G550-75R8ahO26d5k" class="fr-fic fr-fil fr-dib" width="986" height="84"></p><p><strong><span style="font-size: 10pt;">Fig 5. Generating a password.</span></strong></p><p><br></p><p>Now, paste that password into the &quot;Password&quot; box on the Site24x7 webhook.</p><p><br></p><p>Scrolling down will then show the &quot;Manage Tickets Configuration&quot; dropdown. Open this.</p><p><br></p><p>1) Set &quot;Manage Tickets&quot; to &quot;Yes&quot;.</p><p>2) Put the &quot;JSONPath Expression&quot; as &quot;$ticketid&quot;.</p><p>3) Set the methods to &quot;POST&quot;.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA0MWU1NTQzLWZkMDktNDdmYi1hY2NkLThmYmU3NDBiMTFjNSJ9.uDok5NbyE1numdAllD6TWiLPHzIQGIF8ExoEUvG9hSE" class="fr-fic fr-fil fr-dib" width="1233" style="width: 1235px; height: 579.391px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 6. Setting the ticket management settings.</span></strong></p><p><br></p><p>Save, and you have created the webhook. You can click to &quot;Trigger Test Alert&quot; to check your configuration is correct. If it fails, you can view the reason here.</p><p><br></p><p><strong><em>Note: This will not create a ticket.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY3ZDk4NDM3LWNhYzMtNGM0Yy05MTE5LTIzODFmY2UxYzlmZSJ9.ZGbg5Fy0gpzxBBBFBgKduh4zyS9fCf8BwAkARQ-hjY4" class="fr-fic fr-fil fr-dib" width="1229" style="width: 1231px; height: 579.181px;" height="579"></p><p><strong><span style="font-size: 10pt;">Fig 7. Trigger Test Alert</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating Alert Tickets</span></strong></p><p>Now that the webhook is set up, you can configure tickets to be created.</p><p><br></p><p>In the Site24x7 module, you will need to select a ticket type and default user for the tickets to be created. Here we are using the pre-built &quot;Alert&quot; ticket type with no workflow attached to avoid any potential errors, i.e. not creating tickets if they have a mandatory field for example.</p><p><br></p><p>You can also map your Site24x7 fields to custom fields in Halo to bring across any necessary information.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjZjZDkzMzU0LWJlYTktNDI4ZC05ZmIwLTAxNDBkZDBlZjUzNiJ9.P1bXJscXqqG3V65rk_mP-A19EUpn8dfsG1yz53vSKKM" class="fr-fic fr-fil fr-dib" width="1231" style="width: 1233px; height: 267.545px;" height="268"></p><p><strong><span style="font-size: 10pt;">Fig 8. Setting default user and ticket type.</span></strong></p><p><br></p><p>Tickets will be created based on the threshold set in Site24x7 against the monitor.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjFmZTU3ZTliLThlYmQtNGNiYS05ZTJlLTg3ZjgxN2M5MDFiNyJ9.VdxB20flIgKJT9uXo4shdhbn_8_PRCLC8SOzFK4UqDk" class="fr-fic fr-fil fr-dib" width="1231" style="width: 1233px; height: 581.945px;" height="582"></p><p><strong><span style="font-size: 10pt;">Fig 9. Threshold against the monitor.</span></strong></p><p><br></p><p>If the monitor is considered &quot;Down&quot; by this threshold in Site24x7, the alert ticket will be created in Halo.</p><p><br></p><p>It will be opened as the default user you selected. When Alerts are created, a match is attempted against the Customer name using the value provided in the webhook against the &quot;MSP_CUSTOMER_NAME&quot; or &quot;CUSTOMER&quot; field. If a match is found, the General User for the main Site of that Customer is used. If no match is found, the User set in the &quot;New Alert Default User&quot; will be assigned instead.</p><p><br></p><p>Any further actions on the ticket will show as from Site24x7.</p><p><br></p><p>The ticket will also show which monitor it is referencing both in the summary, and in a field in the ticket information.</p><p><br></p><p>Once the monitor is considered up in Site24x7, the webhook will fire and automatically close the ticket.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImY1NTJlZDU1LTgwNjYtNGU3Ni05MDI1LWViMzgxYzY1NjVlNSJ9.iy2wv-3i5Suk3AjC2Smx3UHGrsPoUGo9ROGEtqV6QrA" class="fr-fic fr-fil fr-dib" width="1234" style="width: 1236px; height: 582.216px;" height="582"></p><p><strong><span style="font-size: 10pt;">Fig 10. Ticket created and closed by Site24x7.</span></strong></p><p><br></p><p>To see any webhooks that have been sent regarding Site24x7, the following report can be ran:</p><div style="color: #000000;background-color: #fffffe;font-family: Consolas, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 19px;white-space: pre;" id="isPasted"><span style="color: #0000ff;">SELECT</span><span style="color: #000000;">&nbsp;</span><span style="color: #778899;">*</span><span style="color: #000000;"><br></span><span style="color: #0000ff;">FROM</span><span style="color: #000000;">&nbsp;integrationrequest<br></span><span style="color: #0000ff;">WHERE</span><span style="color: #000000;">&nbsp;irmsid&nbsp;</span><span style="color: #778899;">=</span><span style="color: #000000;">&nbsp;</span><span style="color: #098658;">338</span></div><p><br></p><p><strong><span style="font-size: 14pt;">Asset Matching</span></strong></p><p>Assets will be matched based on the &quot;Asset Matching Field&quot;, against the &quot;MONITORNAME&quot; field provided in the incoming Alert webhook.</p><p><br></p><p>If the &quot;Asset&quot; Field is added to the Ticket Type, this will automatically be linked.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImU2MzYzMDNkLWJhZWUtNDdkZi1iMjUzLTAzOGQxNDRiM2RkMCJ9.wVkC5CrLcuZaIvyCQEpsLkUj1LiCTfx8BsG6_zJsla8" class="fr-fic fr-fil fr-dib" width="592" height="111"></p><p><strong><span style="font-size: 10pt;">Fig 11. Asset matching.</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.