Document toolboxDocument toolbox

Registering Webhooks in JIRA

Owned by ravi.chandran (Unlicensed)
Apr 17, 2020
3 min read

Integrating Qualitia Design Studio projects with your existing JIRA project requires registering webhooks in JIRA accordingly. These webhooks are user-defined callbacks over HTTP used to notify the app or web application on specific events in JIRA. In a way, these webhooks help in alerting the remote application when an issue is getting updated or deleted without periodically polling JIRA (via the REST APIs) to determine whether changes have occurred.

Important Notes

  • You must have JIRA Software 7.5.x or above to integrate JIRA projects with Qualitia Design Studio.
  • Registering these webhooks is a one-time activity and JIRA administrators with global permissions have the right to create new webhooks via an administration console.

For Qualitia Design Studio, you must register 2 different Webhooks. One for update and another for delete events.

For more information on Webhooks and its operations, refer to JIRA documentation.

To create a new webhook in JIRA

This is a one-time activity for every JIRA project. 

  1. Login to JIRA instance as an administrator user.
  2. Navigate to JIRA administration console > System > Webhooks (in the Advanced section).
    (lightbulb) You can also use the quick search (keyboard shortcut is .), then type ‘webhooks’.
  3. Click Create a webhook.
  4. In the form:
    • Enter the webhook Name,
    • Keep status as Enabled.
    • Enter Webhook URL for update events,
      This URL is a combination of Design studio URL along with integration API endpoints.
      Integration API is: /api/integrations/UpdateLinkEventSyncJIRA?projectName=<PROJECTNAME>  
      The sample URL may look like this:
      http://<DESIGN_STUDIO_URL>/api/integrations/UpdateLinkEventSyncJIRA?projectName=<PROJECTNAME>
      In case the project name contains white spaces, trim the spaces while adding the project name here.  
      If the project name is Design Studio then enter DesignStudio in the integration API.



  5. In Issue related events,
    • Enter the project name in appropriate syntax in the textbox. (project = <JIRA_ProjectName>)
    • Select the created and deleted options under the issue links section.



  6. To register your webhook, click Create.


Registering Webhooks in JIRA for Delete Issue Events

After you complete the webhook registration for the update events, you can add the same webhook for delete events. 

(info) In case you have more than one JIRA projects integrated with Qualitia Design Studio, you can add all the projects in the Issue related events section. 

  1. Log on to JIRA instance as an administrator user.
  2. Navigate to JIRA administration console > System > Webhooks (in the Advanced section).
    (lightbulb) You can also use the quick search (keyboard shortcut is .), then type ‘webhooks’.
  3. Click Create a webhook.
  4. In the form:
    • Enter the webhook Name,
    • Keep status as Enabled.
    • Enter Webhook URL for delete events,
      This URL is a combination of the Design studio URL along with integration API endpoints.
      Integration API is: api/integrations/DeleteEventSyncJIRA  
      The sample URL may look like:
      http://<DESIGN_STUDIO_URL>/api/integrations/DeleteEventSyncJIRA



  5. In Issue related events,
    • Enter the project name with appropriate syntax in the textbox. (project = <JIRA_ProjectName>).
      You can add multiple project names enclosed in double-inverted comma (") as mentioned in the screenshot below.
    • Select the deleted options under the Issue section.



  6. To register your webhook, click Create.
    This completes your webhook registration for delete events.

Post webhook registration, you can continue setting up the Qualitia Design Studio project.