Merge supports third-party webhooks for Jira Software! This means Jira Software linked accounts are able to receive Merge-normalized Tickets, whenever a Jira Software issue is created or updated, in real-time!

As with any webhooks, this requires set up on the user’s end. What’s different from most webhooks is that Jira Software does not have a typical signature/secret method, so we use custom headers instead, that user will define in their Jira account.

Steps for your end user to set up webhook in Jira

  1. In your Jira Software account, click on the gear icon on the top right next to your profile picture. This will bring you to System Settings.

  2. Click on Global Automation under the “Automation” header on the left navigation bar. You should see a screen like the one below. Click Create Rule on the top right

  3. Select Multiple issue events as the trigger. Select all issue events, and click Save to save the new trigger.

  4. Create a Send web request as the New action.

  5. Create the webhook with the following values, and then click Save!

    1. Web request URL should be the Merge webhook url, for that linked account.

    2. You must enter the following headers

      1. Jira-Signature-Key. This header’s value is up to you or your end user to define. This should be the same value that your end user will input as the Signature Key for Merge’s Webhook Listener URL. This allows Merge to securely verify & process the webhook data. Merge’s backend checks to make sure that the value in Jira-Signature-Key equals the Signature Key defined for the Merge webhook.

        1. To set up the Signature Key and Webhook Listener URL on Merge’s side, follow the instructions here! You can also use our /webhook-receiver endpoint to set up Merge’s Webhook Listener URL.

      2. Jira-Webhook-Event. This header’s value should be issue. This allows us to detect what type of event this webhook is sending, so that we can appropriately normalize the object to Merge’s Ticket common model.

    3. Set the HTTP Method as POST.

    4. Set the Web Request Body as Issue data (Automation format)

  6. Finally, go to Rule details, and enter the following parameters. Once done, click Save.

    1. Enter a Name

    2. For Scope, select Project type.

    3. For Project type**,** select Software projects. This is because we only want to pull Issues from Jira Software, and not other types of projects like Jira Service Management.

  7. Alas, click Publish changes to activate the webhook!

Did this answer your question?