How to set up webhooks for Jira Data Center

People: Jira System Admins
Plans: All Miro plans (for Jira Server/Data Center integration via OAuth 1.0)
Platforms: Browser, Desktop app (for setup procedures)

To ensure your Jira Cards on a Miro board stay up-to-date, Miro must receive messages from Jira whenever data changes occur. These Jira events are transmitted to Miro via a webhook. 

This guide provides two ways to create webhooks for Jira Server and Jira Data Center using OAuth 1.0 and OAuth2.0.

Create a webhook automatically

When setting up your Jira Cards integration, if you are connecting to Jira Server or Jira Data Center, you can leave the option Create a webhook automatically activated. This is the recommended method.

✏️ Automatic webhook creation requires you to be logged into Jira as a Jira System Administrator.

Jira Cards settings, Step 2: "Create a webhook automatically" is enabled

After the webhook is created automatically, it is a good practice to go to your Jira WebHooks page and edit the webhook to give it a unique name. This is especially important if you plan to connect several Miro teams to your Jira instance.

✏️ For OAuth2.0 connections, the Miro-side connection is set at the company level. One webhook is created for all Miro teams.

✏️ For OAuth 1.0 connections at the Miro team level, a webhook is created per team. At the Miro company level, one webhook is created for all teams.

Create a webhook manually

If you prefer or need to create the webhook manually, follow these steps.

Get the webhook URL from Miro

1. In the Jira Cards settings in Miro (Step 2, when connecting to Jira Server/Data Center), uncheck the option to Create a webhook automatically.
2. Copy & paste your organization's Jira URL and click Connect and save settings.
   
   Jira Cards settings, Step 2: "Create a webhook automatically" is disabled
3. Allow the integration to connect in Jira when prompted.
4. After these steps, Miro will provide you with the WebHook URL:
   Webhook URL provided by Miro

✏️ If you are not a Jira System Administrator, please copy the WebHook URL provided by Miro and send it to your Jira System Administrator so they can create the webhook on the Jira side using the instructions below.

Create the webhook in Jira

Below are the steps to create a WebHook in Jira using the URL obtained from Miro. You can also refer to the official Atlassian documentation for Jira Server and for Jira Cloud (though this article focuses on Server/Data Center).

1. To navigate to the WebHooks page in Jira, go to Jira Administration > System > Advanced > WebHooks (the exact path may vary slightly depending on your Jira version). Alternatively, you can often use a direct link by appending /plugins/servlet/webhooks to your Jira instance URL (e.g., https://YourJiraInstanceName/plugins/servlet/webhooks).
2. Click Create a WebHook in the top right corner of the WebHooks page.
3. Enter a descriptive Name for the WebHook (e.g., "Miro Integration Webhook").
4. Set the WebHook status to Enabled.
5. Paste the WebHook URL copied from the Miro settings into the URL field.
   
   System Webhooks configuration in Jira
6. In the Events section, under Issue, select the events updated and deleted.
7. Click Create to save the webhook.
   
   Jira WebHook event settings
8. After the webhook is created in Jira, return to Step 2 in the Jira Cards settings in Miro, ensure your Jira URL is correctly filled in, and click Connect.

Now the webhook is created and configured. Jira Cards on your Miro boards will update automatically when changes are made in Jira.