How to set up webhook for Jira Cards

Available for: Oauth 1.0.: Jira Server and Data Center ((On-Premise) (LDAP-protected))
Set up by: Jira System Admin.

To update Jira Cards on the board, Miro must receive messages from Jira with the data changes events. These Jira events are transmitted in Miro via a webhook. There are two ways to create a webhook in Miro:

Option 1 (recommended): Create a webhook automatically 

When setting up your Jira cards plugin, select Jira Server or Jira Data Center and leave the option Create a webhook automatically activated.

✏️ Automatic webhook creation requires you to be logged into Jira as an administrator.

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

After creating the webhook don't forget to go to your Jira WebHooks page and edit it to have a unique name in case you plan to connect several Miro teams to your Jira instance.

⚠️ Another webhook will be created for each team's connection so it's important to ensure the naming is unique. When you disconnect teams, any related webhooks are not removed.

Option 2: Create a webhook manually

How to get the webhook

1. 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.
4. You will now have the WebHook URL in Miro:
   Webhook URL

✏️ If you are not a Jira System administrator, please send the WebHook URL to your Jira administrator to create a webhook on the Jira side.

How to apply the WebHook

Below are the steps to create a WebHook. You can also use Atlassian documentation: for Jira Server and for Jira Cloud.

1. To get to the WebHooks page in Jira, go to Administration > System > Advanced > WebHooks. Alternatively, use the following link having added the unique name of your Jira instance (the link works for both Server and Cloud although we cannot guarantee success for every version): https://JiraInstanceName/plugins/servlet/webhooks
2. Click Create a WebHook - the button is in the top right corner:
   
   Create a WebHook button
3. Enter the WebHook Name, set the WebHook status as Enabled, paste the WebHook URL copied from Miro:
   
   System Webhooks in Jira
4. Choose the events updated and deleted in the Issue section and click Create:
   
   Jira WebHook settings
5. Return to Step 2 in Miro settings, fill in your Jira URL, and click Connect.

Now the webhook is created, Jira Cards are enabled and can be updated automatically. All the changes made in Jira are reflected in Jira Cards on the board.