Creating Jira Webhooks

Owned by Edward Stolyar (Deactivated)
Last updated: Oct 15, 2021
3 min read

Webhooks are an essential part of Zephyr integration with Jira. They are used to synchronize Zephyr and Jira requirements and information about defects.

Webhooks can be created in two ways:

  • Zephyr creates a pre-configured webhook automatically when you are mapping a project in Zephyr. In this case, there is no need to perform any additional actions. Later, you can update the created webhook, if needed.

  • You, as an administrator, can create and manage webhooks manually. This can be useful if you do not have (or do not want to create) a Jira service account with permissions required for automatic webhook management.

This topic describes how to create webhooks manually.

Create a webhook manually

Before creating a webhook, you need to map your Zephyr project to a Jira project. In this case, Zephyr will generate a JQL query you will use when creating a webhook. To map a Jira project to your Zephyr project, select the needed Jira project from the Map external Defect project dropdown when creating or editing your Zephyr project. For more information, see Adding a Project.

Steps to perform in Zephyr

  1. Log in to Zephyr as an administrator (Test Manager).

  2. Navigate to Administration > System Setup > Jira Integration:

     

  3. Click the plus button in the top-right corner to start creating a new Jira integration, or click the Edit button to update the existing integration:

  4. In the subsequent dialog:

    1. Set Webhook Management to Manual.

    2. Fill in other information.

    3. Click Confirm.

       

  5. Click Confirm in the next dialog:

     

  6. Check the Jira diagnostic status and click Done:

     

  7. The subsequent Setup Jira Webhooks dialog contains the data you will need to specify in Jira:

    • Webhook URL - the URL where the webhook callback will be sent.

    • JQL Query - a JQL query with the name of the Jira project to be synchronized with your Zephyr project. The project name is shown in the query only if you have mapped your Zephyr project to a Jira project (see above).

Copy both the Webhook URL and JQL Query for later use.

8. Once done, click Confirm.

Steps to perform in Jira

  1. Log in to Jira as an administrator.

  2. Navigate to Settings > Webhooks and click Create a WebHook:

  3. On the next screen:

    1. Specify a Name for your webhook.

    2. Set the Status to Enabled.

    3. In the URL field, paste the webhook URL you have copied in Zephyr.

    4. In the Issue related events text box, paste the JQL query you have copied from Zephyr.

    5. Select the check boxes next to these events:

      • Issue

        • created

        • updated

        • deleted

      • Project

        • updated

        • deleted

      • Version

        • released

        • unreleased

        • created

        • moved

        • updated

        • deleted

  4. Once done, click Create at the bottom of the page:


    Your webhook has been created:

See also

Jira Integration
Setting up Jira Integration