App Center | HockeyApp will be transitioning into App Center on Nov. 1, 2019.

How to set up a webhook in JIRA

JIRA webhooks allow your JIRA to indicate that an issue was changed, so HockeyApp can update the status of the corresponding crash group automatically. Note that this requires JIRA 5.2 or newer.

Basic Setup

Follow these steps to set up the webhook:

In HockeyApp:

  1. Click on your app on the dashboard, then on Manage App > Bug Tracker.
  2. If not already done, configure your JIRA instance.
  3. After successfully authenticating against JIRA, copy the webhook URL from the HockeyApp page for JIRA settings to your clipboard.

In JIRA:

  1. Sign in with an admin account, then select Administration > System.
  2. Click on Webhooks in the left sidebar, then on Create a Webhook.
  3. Fill in a name, e.g. "HockeyApp Webhook".
  4. Paste the copied URL in the URL field.
  5. Enable the option Exclude issue details from the POST to URL. (see below).
  6. Enable the event Issue Updated.
  7. Click on Create to save the webhook.

Your configuration should look similar to this screenshot:

JIRAWebhook.png

Privacy Considerations

As described in step 8, please enable the option Exclude issue details from the POST to URL in the webhook configuration. This ensure that no data other than the issue key (e.g. APP-001) is posted to HockeyApp. After the webhook is called, HockeyApp checks if the issue key exists in HockeyApp and is connected to a valid tracker configuration. Only then it fetches the issue status from JIRA.

Additional Configuration

The webhook configuration allows you to set a JQL query which is evaluated before the webhook is called. The following query can be set to filter the issues for the project with the key APP:

project=APP

Details on JQL can be found in the JIRA configuration.

Troubleshooting Errors

JIRA field errors indicate that you likely have custom fields marked as mandatory in your JIRA instance that will need to be set to optional in JIRA instead since HockeyApp cannot set them.

JIRA authentication errors indicate that you likely specified your e-mail address instead of your JIRA username. (You can find your username in JIRA by clicking on your avatar in the top-right corner, and then clicking on "Profile").