Browse Guides

Jira Service Management 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><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 id="isPasted"><strong>In this guide we will cover:</strong></p><p><strong>- What is the Jira Service Management Integration?</strong></p><p><strong>- Enabling the Module</strong></p><p><strong>- Connecting to Jira Service Management</strong></p><p><strong>- Syncing to Jira Service Management</strong></p><p><strong>- Syncing Back to Halo (Webhooks)</strong></p><p><strong>- Linked Tickets</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is the Jira Service Management Integration?<br></span></strong></p><p>The Jira Service Management integration allows a two way sync between Halo and Jira Service Management. New tickets logged in Halo can be sent to Jira and new requests logged in Jira can be sent to Halo. Updates t requests/tickets in both tools can be sent back to the other. &nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Module</span></strong></p><p>The integration needs to be enabled from the integration configuration area, but the credentials and field mappings are configured per customer/supplier. To enable Jira Service Management hover over the module and click the plus sign (+) in the top right.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRiOTM2NWU2LTVmMjItNDQ2Ni1hMDY5LTA1MDc4Y2U5ZjE2ZiJ9.yGWOUlnBvU324r3rOQZnOIEfbLFMzIvkPGuHfnGQVc8" class="fr-fic fr-fil fr-dib" width="117" height="136"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the module</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Jira</span></strong></p><p>Once the integration is enabled, a Jira Service Management tab will appear on the Customer and Suppliers details page. Here you can enter the credentials for their instance of Jira Service Management. These credentials must be validated before setting up any of the mappings.</p><p><br></p><p>To obtain an API token click &quot;Edit&quot; follow the link found on under the Jira Service Management tab in Halo. This link will only show when editing the page.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImRiYmQxN2ZjLTRhYzYtNGRkMi1hMDg5LWY3ZjQ3M2M4YjRiMCJ9.0ke6G2ihZH-1ROZlxNIXyuCibzLK7Au_Wy0qU9-JJfA" class="fr-fic fr-fil fr-dib" width="1194" style="width: 1196px; height: 438.603px;" height="439"></p><p><strong><span style="font-size: 10pt;">Fig 2. Credentials page. Link to obtain API Token highlighted</span></strong></p><p><br></p><p>When creating the API token, you must use the &quot;Create API token&quot; option.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0OWM2ZTBhLTEyNDAtNDBiOC1iMDc5LTNiYmUyYjg1MWYzNyJ9.vgJn_p_WF2Nm3BlLtQNo3XnqpNnc-BH43P5U6B3mNTs" class="fr-fic fr-fil fr-dib" width="1165" style="width: 1167px; height: 454.079px;" height="454"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 3. Create API Token in Jira</span></strong></p><p><br></p><p>The API token generated will inherit the permissions of the user that generates it. For ease of setup have an admin user generate the key, this will allow webhooks in Jira to be created with the click of a button in Halo (as only admins can create webhooks).&nbsp;</p><p><br></p><p>Otherwise, the minimum permissions the user needs is as follows:</p><ul><li>Access to the Jira Service Management App</li><li>Browse (view) the project</li><li>Create issues in the project</li><li>Edit issues in the project</li><li>Assign issues in the project</li><li>Resolve issues in the project</li><li>Add comments in the project</li><li>View comments in the project</li></ul><p><br></p><p><strong><em>Note: Permissions in Jira are configured per project, note per user, therefore the user will need access to the project(s) you would sync with Halo.&nbsp;</em></strong></p><p><br></p><p>Now head back to Halo and fill in the API details you have generated, including your Jira URL, Username/Email, and the API Key (this will need to go in the &nbsp;&quot;Password&quot; field). &nbsp;Once you have enetered these details, click &quot;Save&quot; followed by the &quot;Validate Credentials&quot; button.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhmN2E0YzI4LTQ1MTEtNDUxOS05YzNhLWQzM2Q0NzY1NDRlMyJ9.hzAARXYmHVXbBaA6NB5zlPABfdxDdV_YC4t2cwGV5Bc" class="fr-fic fr-fil fr-dib" width="976" style="width: 978px; height: 303.867px;" height="304"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 4. Connecting to Jira Service Management&nbsp;</span></strong></p><p><br></p><p>Once validated, a new section will become available on the Jira Service Management tab of the Customer or Supplier. Here you can configure mappings for request type, priority, and status, as well as a default reporter and service desk for the requests.</p><p><br></p><p><strong id="isPasted">Default Status After Jira Update&nbsp;</strong>- Here, you can set the default status tickets will be moved to when an update is received from Jira. If the issue in Jira has a status that is mapped to a Halo status the mapped status will always be used, otherwise the Halo ticket will move into the status chosen here.</p><p><br></p><p><em><strong>Note: Status is not synced outbound from Halo to Jira.</strong></em></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY1NDMxYjQ3LTg3NGItNGRmOS05OTJhLTk0ZDQ2MWZmYjNkZSJ9.pzKQJB-geQ3eXzQ6yCQfU0v6V7HIbiivYQ4cfKH_z0Y" class="fr-fic fr-fil fr-dib" width="1030" style="width: 1032px; height: 631.032px;" height="631"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 5. Mappings</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Syncing to Jira Service Management</span></strong></p><p><span style="font-size: 12pt;"><strong>Customers</strong></span></p><p>To sync requests, you can create an action with the system use &#39;Send ticket to Jira Service Management&#39;. This will send the current ticket to the Jira Service Management instance of the customer the ticket is assigned to, if the quick action checkbox is selected, the ticket will automatically send to Jira when the action button is clicked. Only one incident may be linked to a ticket at a time. If the &#39;Send ticket to Jira Service Management &#39; is used again on the same ticket, the existing link will be overwritten.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc2OTBhMDM5LTUyODMtNDc5Yi05YzBlLTQwOGU5NTZmZDYxNCJ9.DuDiEw1PX8cq4uaoJFTVzRbL-IJoetz8FuQy1HmaluM" class="fr-fic fr-fil fr-dib" width="927" height="347"></p><p data-pasted="true" style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;"><strong style="box-sizing: inherit; font-weight: 700;"><span style="box-sizing: inherit; font-size: 10pt;">Fig 6. Sending to Jira Service Management System Use</span></strong></p><p style="box-sizing: inherit; margin: 0px; line-height: 1.4285em;">&nbsp;</p><p><em><strong>Note:&nbsp;</strong></em><strong><em>Only the first note on the ticket posts to Jira Service Management</em></strong></p><p><br></p><p><strong><em><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ4ZDJhZDQyLWQ0NGMtNDZlZS1iMGQ2LTg0YzExNGJkNDQ5MiJ9.4oIU5tNjc71LC2SYXERhIh5iO5ovtBI22ZxHSQEdPEo" class="fr-fic fr-fil fr-dib" width="862" style="width: 864px; height: 245.215px;" height="245"></em></strong></p><p><strong><span style="font-size: 10pt;">Fig 7. Syncing to Jira</span></strong></p><p><br></p><p>After the Request is sent over, there will be a Jira Service Management ID displayed on the ticket information, which is hyperlinked to the ticket on Jira.</p><p><br></p><p>The user of the Change Request will try to match on the email of the ticket in Halo but will fall back to the default user if there is no user with that email in Jira Service Management.</p><p><br></p><p>To send an action to the Jira Service Management request, you can create an action with the note and &#39;Sync to Jira Service Management&#39; fields, this option is used so the sync to Jira can be decided per action. This is the recommended approach if you are using a generic close action for all customers, some of which may not be connected to Jira.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQzYTI2ZGViLTJmYzUtNGJkYi1iNTc2LTU3NmFmYWRkY2IzMSJ9.YD7TQw9_HhP_SvNdm-Un_VQfBf1Ou6XBOonrfJHsu2o" class="fr-fic fr-fil fr-dib" width="969" style="width: 971px; height: 352.905px;" height="353"></p><p data-pasted="true"><strong data-pasted="true"><span style="font-size: 10pt;">Fig 8. Sync option on an action</span></strong></p><p><br></p><p data-pasted="true">Each &quot;Send Update to Jira&quot; action has a checkbox option when using the field &quot;Sync to Jira Service Management&quot; on the field list of the action.</p><p><br></p><p>This can also be set as a default on an action. If checked, the action will be sent to the linked request as soon as it is saved, there is no checkbox on the action.</p><p><br></p><p><img data-fr-image-pasted="true" src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdiZTYzZDgxLWI1ODktNGM5NS05NjlhLTg4MjIxOWZiMDIxZiJ9.acVVrzY0uiWE0sNpNJLx32pKwgCzbj7F97_TMTynpd8" width="399" height="240" style="box-sizing: inherit; border-style: none; cursor: pointer; padding: 0px 1px; user-select: none; text-align: left; color: rgb(0, 0, 0); font-family: sans-serif; font-size: 13.3333px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 700; letter-spacing: normal; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; white-space: normal; background-color: rgb(255, 255, 255); text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; max-width: none !important;" data-pasted="true" class="fr-fil fr-dib"></p><p><strong><span style="font-size: 10pt;">Fig 9. Syncing option</span></strong></p><p><br></p><p><em><strong>Note:&nbsp;</strong></em><strong><em>The options &quot;Send attachments to Jira&quot;, and &quot;Send to Jira&quot; do not work with the Jira Service Management Integration, this is for the Jira Software integration.</em></strong></p><p><br></p><p>It is Recommended to Have two actions for sending updates: Update Jira Ticket, Private Update Jira Ticket. If the action is set to private it will be private in Jira Service Management.</p><p><br></p><p><em><strong>Note:&nbsp;</strong></em><strong><em>The action field posted to Jira must be the &quot;Note&quot; Field, Private Note does not work.</em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBlYzU1MjdlLTRiYTQtNDc2My04ODg0LTAyMmZmNzk1MGI4YiJ9.Vx0HVobE0ZsUTYp_lT21u1iveO0ni9GBST57bhHskRU" class="fr-fic fr-fil fr-dib" width="836" style="width: 836px; height: 192.923px;" height="192.923"></p><p><strong><span style="font-size: 10pt;">Fig 10. Action in Jira</span></strong></p><p><br></p><p>Using the action Update Jira Ticket.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjA1NjRkN2Q3LTM0ZGQtNDQxZC1iNTBkLWVlZmIzYzRjZGY2NSJ9.VvEFYD_zn6c-Z4ScCIylKcGozfx3eCtxpkN6cGDuPWY" class="fr-fic fr-fil fr-dib" width="815" style="width: 815px; height: 235.921px;" height="235.921"></p><p><strong><span style="font-size: 10pt;">Fig 11. Jira ticket</span></strong></p><p><br></p><p>No other updates to the ticket in Halo will be synced to the incident in Jira Service Management.</p><p><br></p><p><strong><span style="font-size: 12pt;">Suppliers</span></strong></p><p>The suppliers function similarly to the customers, except instead of requiring the specific Jira Service Management system use and field, the request will be created when using the &#39;Log to Supplier&#39; system use if the selected supplier is connected to Jira Service Management. Similarly, actions can be sent to the request by using the &#39;Email supplier&#39; system use if the supplier linked to the ticket is connected to Jira Service Management.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZkZjJkOTM1LWU5ZmEtNDg0Ni04YmIzLWUzMzVhZDMyNTE0ZCJ9.AyTV5ptp8ehOJ1gD2V8c3ibexIcne0A_rUF56ia2WH0" class="fr-fic fr-fil fr-dib" width="1077" style="width: 1079px; height: 483.407px;" height="483"></p><p><strong><span style="font-size: 10pt;">Fig 12. Jira tab on a supplier</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Syncing Back to Halo</span></strong></p><p><span style="font-size: 11pt;">Webhooks in Jira are used to create tickets in Halo and sync updates to requests from Jira back to Halo.&nbsp;</span></p><p><br></p><p><span style="font-size: 11pt;">You must first allow webhooks to be processed for each customer in Halo. Head to the customer profile in Halo &gt; Jira Service Management tab &gt; Webhooks section and enable &quot;Allow Jira webhooks to be processed by Halo&quot;.&nbsp;</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0ODdjOGVmLWNhN2YtNDU2YS1hMjFlLTRlNjg1ZDQzNTFhMyJ9.jK31GKDy4Uun2pGxk2NIDzHxPpRANLh9jiR7F_xE2cY" class="fr-fic fr-fil fr-dib" width="1203" style="width: 1205px; height: 621.216px;" height="621"></p><p><strong><span style="font-size: 10pt;">Fig 12. Webhooks configuration for customer</span></strong></p><p><br></p><p>When enabled, choose which authentication method you would like webhooks to require.</p><p><br></p><p>If using &quot;Signature validation&quot;, you will need to generate a secret in Jira an enter it here.&nbsp;</p><p><br></p><p>Then choose the &quot;Webhook User&quot;. This will be the user new requests will be assigned to if they cannot be matched to a user in Halo.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Webhook Creation</span></strong></p><p>Click the &quot;Create webhook in Jira&quot; button to automatically create the webhook in the customer&#39;s Jira instance. This will create a webhook called &quot;Halo Jira Service Management Integration&quot;.&nbsp;</p><p><br></p><p><strong><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImJiNTllYTdjLWQ4ZjgtNGM0NC05ODBkLWY3OTYzNzJiOTQ4MyJ9.zk-jUJdr5tWMMb5HP7fY2geVEWCBz5nHKHvn8V3Z6qQ" class="fr-fic fr-fil fr-dib" width="1148" style="width: 1150px; height: 547.54px;" height="548"></strong></p><p><strong><span style="font-size: 10pt;">Fig 14. Create webhook in Jira</span></strong></p><p><br></p><p><span style="font-size: 11pt;">To check if the webhook has created successfully, in Jira, head to settings (top right) &gt; System &gt; WebHooks, look for a webhook called &quot;Halo Jira Service Management Integration&quot;.</span></p><p><br></p><p><strong><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjBiNTVhMTZhLThiYjEtNGRkZS05MGY2LWYxNDM2MTJkM2RmOCJ9.w1Mf0bqXdum82DUga6MQSCKTAiCw6U4ccpglTLPHyt0" class="fr-fic fr-fil fr-dib" width="1001" style="width: 1003px; height: 739.523px;" height="740"></strong></p><p><strong><span style="font-size: 10pt;">Fig 15. Webhook created in Jira</span></strong></p><p><strong><br></strong></p><p>This will only work if the user who has generated the API key to connect to the customer&#39;s Jira is an administrator. If the user was not an administrator the webhook will not create and you will need to create the webhook manually. To manually create the webhook it will need to be configured as shown in figure 16. &nbsp;</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNmMTYyMTMyLTY3MzEtNDNiMi1hNGNjLTc1ZWVhODZjOTg0NSJ9.qlGKMKqfk5R0rz1sfpJlpuFq-Po-ML5QJ3ZI3V1TRNI" class="fr-fic fr-fil fr-dib" width="1010" style="width: 1012px; height: 370.177px;" height="370"></p><p><strong><span style="font-size: 10pt;">Fig 16. Webhook configuration</span></strong></p><p><br></p><p>The URL for the webhook will follow the format <a target="_blank" rel="noopener noreferrer noopener noreferrer" data-fr-linked="true" href="https://YOURHALODOMAIN/api/notify/jiraservicemanagement">https://YOURHALODOMAIN/api/notify/jiraservicemanagement</a>.&nbsp;</p><p><strong><br></strong></p><p><span style="font-size: 11pt;">Now, when new requests are raised in Jira these will be created as tickets in Halo. The ticket type it is created as will be determined by the Request Type Mappings in Halo.&nbsp;</span></p><p><strong style="background-color: transparent; font-size: 13px;"><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImQ2NjBmZmY5LWZkN2ItNDVkOS1iMGU5LWZhNDNmNDBlNTBkMyJ9.qFoQSddj8qJzjt6akgcLRX-57YpSCW1wPCrBsMqmHMU" class="fr-fic fr-fil fr-dib" width="683" style="width: 685px; height: 705.397px;" height="705"></strong></p><p><strong><span style="font-size: 10pt;">Fig 17. Request raised in Jira</span></strong></p><p><br></p><p><strong><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImNkYTg4YWZjLTc5MDktNDU2OC05M2E2LTFkMGUxZjQwZjYyNyJ9.i-4z0GFwv-2-1dOaAB7WzFjabBYzUg_HsUfLgPLpnpc" class="fr-fic fr-fil fr-dib" width="1108" style="width: 1110px; height: 468.225px;" height="468"></strong></p><p><strong><span style="font-size: 10pt;">Fig 18. Ticket logged in Halo</span></strong></p><p><strong><br></strong></p><p data-pasted="true"><span style="font-size: 11pt;">When comments are added to requests in Jira, these will be synced to the ticket in Halo. The ticket in Halo must be linked to a Jira request for this sync to be successful. Links are established by creating a ticket/request in one tool from the other.&nbsp;</span></p><p><br></p><p><strong><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI0ODFlOGQ4LTAwY2EtNDUyOC1iZDQ5LTE4ZjRjMzhiYzkxMiJ9.ew6tr1cNSG-mI6zSOmw2UO3I1DgvSGupYBlMqAgrAy8" class="fr-fic fr-fil fr-dib" width="895" style="width: 897px; height: 653.287px;" height="653"></strong></p><p><strong><span style="font-size: 10pt;">Fig 19. Comment added to request in Jira</span></strong></p><p><strong><br></strong></p><p><strong><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNmMGIyOWExLThlNDktNDA4My05NTQ5LTUxMDYyMzcyY2I4MSJ9.-SfWqqSnXfUmOrzezg4Jy7KxAtJHPwwmxvbEoPa6Ntc" class="fr-fic fr-fil fr-dib" width="1208" style="width: 1210px; height: 520.897px;" height="521"></strong></p><p><strong><span style="font-size: 10pt;">Fig 20. Comment synced to ticket in Halo</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Restrict when the Webhook is Triggered</span></strong></p><p><span style="font-size: 11pt;">By default, the webhook will trigger for all issues that are created and updated in Jira, sending a request to Halo. However, only requests that match to a ticket in Halo will actually update a ticket.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">If you would like to restrict when requests are sent you can add a JQL filter to the webhook. This can be used to only have the webhook trigger for issues are created for a selected project, issues created of a certain type, etc.&nbsp;</span></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">In the figure 21 example we have configure a filter such that the webhook will only trigger for issues created and updated under the project with the name &quot;Project 1&quot;.</span></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwZTI0MmViLWM0YTItNDE0YS1hMTBjLWI0ZmZhOTE5ZDEzOCJ9.HpQD8I14yGeLgaFr3CiYXxELIgPL7MV_IuScA2aydhU" class="fr-fic fr-fil fr-dib" width="1069" height="290"></p><p><strong><span style="font-size: 10pt;">Fig 21. Webhook set to trigger when issues and comments are created under Project 1</span></strong></p><p><br></p><p>For more information on configuring JQL filters checkout: <a target="_blank" rel="noopener noreferrer noopener noreferrer noopener noreferrer noopener noreferrer" data-fr-linked="true" href="https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/">https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/</a>.</p><p><br></p><p><strong><span style="font-size: 12pt;">Considerations when Creating Tickets in Halo from Jira</span></strong></p><p>When a ticket is created &nbsp;the summary of the request will be used as the summary of the ticket and the priority will be synced across. No other fields will be synced.</p><p><br></p><p>Ensure the following criteria are met for tickets to be successfully created in Halo from Jira:</p><ul><li>Ensure the request type being logged is mapped to a Halo ticket type</li><li>Ensure there are no mandatory fields on the Halo ticket type attempting to be logged (excluding priority)</li><li>Ensure the &quot;Priority&quot; field is added to the request type in Jira, and set.</li><li>Ensure you have completed priority mappings</li></ul><p><strong><span style="font-size: 12pt;">Considerations when Updating Tickets in Halo from Jira&nbsp;</span></strong></p><p>Only tickets that are linked to Jira requests can have comments synced. To link a ticket to a request you will need to create the ticket from Jira, or create the request from Halo, this will establish a link.&nbsp;</p><p><br></p><p>Comments added to requests will be synced, updates to the priority and status fields will sync. Other fields will not sync across.&nbsp;</p><p><br></p><p><strong><span style="font-size: 12pt;">Suppliers</span></strong></p><p>Creating and updating tickets from Jira for suppliers can be configured the same way. Simply create the webhook using the button in Halo and this will create the required webhook in the supplier&#39;s Jira instance.&nbsp;</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU0OGRmN2MzLThiZTQtNDU4ZC1iMWNmLTYwMjJkZjE5OTQ3MiJ9.I5oAoVbUP2ijWPRlS-p1_nc8MkQKiGgXJ-1e-JJCt_k" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 362.977px;" height="363"></p><p><strong><span style="font-size: 10pt;">Fig 22. Suppliers</span></strong></p><p><br></p><p>For more information on suppliers, check out this guide: <a href="https://usehalo.com/haloitsm/guides/2101/" rel="noopener noreferrer" target="_blank"><strong>Suppliers in Halo</strong></a>. For example you may want to configure certain actions with the &quot;Log to Supplier&quot; system use to include the checkbox.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY2ZWMwODY3LTVmYWMtNDU0Ni1hODE2LWI4YjM3ODBhMzZkZCJ9.hWbY0NzfmTXCgx19jPkW0GozFLS2HpcI6dw3HlDLsqM" class="fr-fic fr-fil fr-dib" width="534" height="189"></p><p><strong><span style="font-size: 10pt;">Fig 23. Sync option on log to supplier action</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Linked Tickets</span></strong></p><p>Tickets that are linked to Jira will show a tab that outlines details of the linked ticket such as its ID, Type, Title, and who it is assigned to.</p><p><br></p><p>You can see the current status of the Jira ticket here as well, without having to change the Halo status through mapped statuses. This information is also stored in the &quot;ELThirdPartyStatus&quot; column in the &quot;ExternalLink&quot; table.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNiZjdmYjdkLTQ3MDItNDk4OS1hYzgxLTIzNzVhMGVkYjM2OCJ9.GEuNwY8on_zuRvtUcqufZIVrZ6sJEgOAopfCooXS69k" class="fr-fic fr-fil fr-dib" width="1215" style="width: 1217px; height: 198.933px;" height="199"></p><p><strong><span style="font-size: 10pt;">Fig 24. Status on the ticket</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.