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 webhookswebhook 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.

...

Steps to perform in Zephyr

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

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

   Image Modified

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:
   

   Image Modified

4. In the subsequent dialog:

   1. Set Webhook Management to Manual.

   2. Fill in other information.

   3. Click Confirm.
      

...

1. 1. Image Added

2. Click Confirm in the next dialog:
   

...

1. Image Added

2. Check the Jira diagnostic status and click Done:
   

...

1. Image Added

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

   • Webhook URL - the URLwhere 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).

...

Steps to perform in Jira

Anchor
inJira inJira

1. Log in to Jira as an administrator.

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

   Image Modified

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.
      

...

1. 1. Image Added

   2. Select the check boxes next to these events:

      • Issue

        • created

        • updated

        • deleted

...

Project

• updated

• deleted

...

Version

• released

• unreleased

• created

• moved

• updated

• deleted
  

  Image Removed

...

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

...

4. Image Added

   
   Your webhook has been created

...

4. .

...

See also

Jira Integration
Setting up Jira Integration