Configuring a Jira Cloud webhook for field syncing

<div class="article-banners">
<div id="docs-wmp-link"><a href="https://support.zendesk.com/hc/en-us/articles/5411234991258-plan" target="_blank" rel="noopener noreferrer">What's my plan?</a></div>
<div class="article-banner" id="suite_all"><figure class="wysiwyg-table wysiwyg-table-align-left"><table><tbody><tr>
<td><strong>All Suites</strong></td>
<td>Team, Growth, Professional, Enterprise, or Enterprise Plus</td>
</tr></tbody></table></figure></div>
<div class="article-banner" id="support_all"><figure class="wysiwyg-table wysiwyg-table-align-left"><table><tbody><tr>
<td><strong>Support</strong></td>
<td>Team, Professional, or Enterprise</td>
</tr></tbody></table></figure></div>
</div><div class="body">
<p class="p">When saving field mappings to enable field syncing, the Zendesk Support for Jira integration registers a Jira webhook. The webhook is designed to be triggered whenever a linked issue is updated, moved, or deleted by a user to inform the integration that data has changed and syncing may be required. </p>
<p class="p">Jira Cloud doesn't automatically create webhooks by third-party add-ons like Zendesk Support for Jira. Jira administrators must manually create a webhook for field syncing to work properly.</p>
<p class="p">This article includes the following topics:</p>
<ul>
<li data-list-item-id="efed88355b5237c5da325de6f21617841"><p class="p"><a href="#h_01KCQ87F6DWA759S92JPFDFY2K">Configuring a Jira webhook</a></p></li>
<li data-list-item-id="e1688d7166d0ddb025e5aa95c254ef76c"><p class="p"><a href="#h_01KCQ88YV26H37KTDGW7AW7TG6">Configuring a Jira webook (legacy Jira integration)</a></p></li>
</ul>
<div class="p">
<h2 id="h_01KCQ87F6DWA759S92JPFDFY2K">Configuring a Jira webhook</h2>
<p>Follow these steps to configure a Jira webhook for field syncing. If you're using the legacy integration, see <a href="#h_01KCQ88YV26H37KTDGW7AW7TG6">Configuring a Jira webook (legacy Jira integration)</a>.</p>
<p><span class="notetitle">Note:</span> It is important that you follow these instructions carefully, including entering the correct webhook name.</p>
</div>
<p class="p"><strong class="ph b">To configure a Jira webhook</strong></p>
<div class="p">
<ol class="ol" id="jira_webhook_fieldsync__ol_akd_lnt_ljb">
<li class="li" data-list-item-id="e22835029826fedfef3ba6d08ac015331">In Admin Center, click <strong>Apps and integrations</strong> in the sidebar, then select <strong>Integrations</strong> &gt; <strong>Integrations</strong>.</li>
<li class="li" data-list-item-id="e4fde520ce968c9b72266e7fc8d826892">Click the <strong>Jira</strong> link.</li>
<li class="li" data-list-item-id="e323b3cb5304080fa578df936fec0c5b2">If you have multiple connections, click the name of the connection you are setting up.</li>
<li class="li" data-list-item-id="e51c173c099a35aeab0104e6eca28091e">Click the <strong>Field mapping</strong> tab.</li>
<li class="li" data-list-item-id="e7a5fc1ed9179d3afbe56ca9aa8e85185">Select <strong>Turn on Jira to Zendesk sync</strong>, then click <strong>Copy webhook URL to clipboard</strong>.</li>
<li class="li" data-list-item-id="e29edc4800d9a9fcb484e09ca3613c34a">In Jira, click the <strong class="ph b">Settings</strong> cog icon, and under <strong class="ph b">Jira Settings</strong>, click <strong class="ph b">System</strong>.</li>
<li class="li" data-list-item-id="eb88c7af20b3aa71ceffd4f7dae2259b1">Select <strong class="ph b">Advanced</strong> &gt; <strong class="ph b">WebHooks</strong> in the left navigation menu.</li>
<li class="li" data-list-item-id="e7f45141f5d1fc5f3c5f84a662973b90a">Click <strong class="ph b">Create a WebHook</strong> in the upper-right of the screen.</li>
<li class="li" data-list-item-id="e94f3ad2827380ed23c6f2fc0b93f5b8d">
<p>Enter the following information:</p>
<div class="p"><ul class="ul" id="jira_webhook_fieldsync__ul_vh4_vnt_ljb">
<li class="li" data-list-item-id="ee1f3d37cec120a715eda2b231c692ea4">
<strong class="ph b">Name</strong>: Enter <samp class="ph systemoutput">(Zendesk add-on) Sync with Zendesk on issue update (do not change) - V2</samp>
</li>
<li class="li" data-list-item-id="ed9d08d2a66428a7004ff8d78bf3704e4">
<strong class="ph b">Status</strong>: Select <strong class="ph b">Enabled</strong>
</li>
<li class="li" data-list-item-id="ed0610fe4cf7aa3fe6da2d9d9443199fc">
<strong class="ph b">URL</strong>: Enter your WebHook URL that you previously copied in Step 3. We have provided a convenient mechanism to get the WebHook URL with all placeholders replaced with the correct values for your Zendesk account.</li>
<li class="li" data-list-item-id="e4be9137326e53e3517e6ee9222f70e01">
<strong class="ph b">Secret: </strong>Create the secret and paste it into the Field mapping tab when <a href="https://support.zendesk.com/hc/en-us/articles/9827183512730#topic_ith_yzh_2z" target="_blank" rel="noopener noreferrer">setting up Zendesk to Jira field sync</a>.</li>
<li class="li" data-list-item-id="eeb59f4fde708daddd4765f1330ce6b72">
<strong class="ph b">Events</strong>: <samp class="ph systemoutput">labels = jira_escalated</samp>
</li>
<li class="li" data-list-item-id="e2f5af38a9a3c866cafc25cec400126f1">
<strong class="ph b">Issue</strong>: Select <strong class="ph b">updated</strong> and <strong class="ph b">deleted</strong>
</li>
<li class="li" data-list-item-id="ee37cae8e86cb6f30ed23e9743ecc99ef">
<strong class="ph b">Exclude body</strong>: Do not select this option.<br><img class="wysiwyg-image img-screenshot" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/jira_cloud_webhook_configure_4.png" alt="" width="800" id="jira_webhook_fieldsync__image_dh5_tpz_ljb">
</li>
</ul></div>
</li>
<li class="li" data-list-item-id="e285a9c7433eda0465767e4d940e0f9ff">Click <strong class="ph b">Save</strong>. The WebHooks page displays the webhook details:<br><img class="wysiwyg-image img-screenshot" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/jira_cloud_webhook_details_2.png" alt="" width="800" id="jira_webhook_fieldsync__image_z2y_wpz_ljb">
</li>
</ol>
<h2 id="h_01KCQ88YV26H37KTDGW7AW7TG6">Configuring a Jira webook (legacy Jira integration)</h2>
<p>Follow these steps if you're using the legacy Jira integration.</p>
<p><strong>To configure a Jira webhook (legacy integration)</strong></p>
<ol class="ol" id="jira_webhook_fieldsync__ol_akd_lnt_ljb">
<li class="li" data-list-item-id="e258c883d05e23b5783d81123504932c5">Log in to Jira as an administrator, and in the top navigation bar, select <strong>Apps</strong> &gt; <strong>Manage your apps</strong>.</li>
<li class="li" data-list-item-id="ed77d86b749224611f32dcad8a7aee13b">Select <strong>Zendesk Support for JIRA</strong> in the accordion, then click <strong>Configure</strong>.</li>
<li class="li" data-list-item-id="ec6103f44d6b7fd1ba5d26a757bed3c11">Select <strong>Field Mapping</strong> in the left navigation pane, then click <strong>Copy webhook URL to clipboard</strong>.</li>
<li class="li" data-list-item-id="e84679c4efce741f28d2a7cd8ed138c5c">Click the <strong class="ph b">Settings</strong> cog icon, and under <strong class="ph b">Jira Settings</strong>, click <strong class="ph b">System</strong>.</li>
<li class="li" data-list-item-id="e807d41ebace057c3252aceb96395af0f">Select <strong class="ph b">Advanced</strong> &gt; <strong class="ph b">WebHooks</strong> in the left navigation menu.</li>
<li class="li" data-list-item-id="e683d6d15e60f3117742ebfe037004080">Click <strong class="ph b">Create a WebHook</strong> in the upper-right of the screen.</li>
<li class="li" data-list-item-id="e71823edbf16cde7ed6dda8f926dc8c8a">
<p>Enter the following information:</p>
<div class="p"><ul class="ul" id="jira_webhook_fieldsync__ul_vh4_vnt_ljb">
<li class="li" data-list-item-id="e347cbf2c94787a6159a79207153204f6">
<strong class="ph b">Name</strong>: Enter <samp class="ph systemoutput">(Zendesk add-on) Sync with Zendesk on issue update (do not change) - V2</samp>
</li>
<li class="li" data-list-item-id="e4b69e7d784660ddc265a5dde3015f54c">
<strong class="ph b">Status</strong>: Select <strong class="ph b">Enabled</strong>
</li>
<li class="li" data-list-item-id="e7d59437ba0b6554c579bc76b5f5c7e56">
<strong class="ph b">URL</strong>: Enter your WebHook URL that you previously copied in Step 3. We have provided a convenient mechanism to get the WebHook URL with all placeholders replaced with the correct values for your Zendesk account.</li>
<li class="li" data-list-item-id="e0298b34dd79c468a341f2be2a31c9817">
<strong class="ph b">Events</strong>: <samp class="ph systemoutput">labels = jira_escalated</samp>
</li>
<li class="li" data-list-item-id="eeaa1c8cb71b8bd994f914b91b2062e8b">
<strong class="ph b">Issue</strong>: Select <strong class="ph b">updated</strong> and <strong class="ph b">deleted</strong>
</li>
<li class="li" data-list-item-id="e5c386427253a6cc2c4984d7a4cb57b3e">
<strong class="ph b">Exclude body</strong>: Do not select this option.</li>
</ul></div>
</li>
<li class="li" data-list-item-id="abc">Click <strong>Save</strong>. The WebHooks page displays the webhook details.</li>
</ol>
<p> </p>
<p><br> </p>
</div>
</div>