Configure webhooks in Jira manually

  • Release version: Washingtondc
  • Updated August 1, 2024
  • 1 minute to read

    • Configure webhooks in your Jira Server or Jira Cloud instance to send sync notifications to the DevOps Change Velocity application.

    Before you begin

    Role required:
    • sn_devops.admin or sn_devops.tool_owner in DevOps Change Velocity.
    • Jira admin role in your Jira Server or Jira Cloud instance.

    About this task

    If you have connected your Jira tool using OAuth 2.0 based authentication, the webhooks are created for the OAuth 2.0 integration app in Jira when you configure automatically, whereas if you have connected using basic authentication, the webhooks are created for all your projects in Jira. If you choose to configure the webhooks manually for a Jira tool created using OAuth 2.0 based authentication, a duplicate webhook may get created.

    Procedure

    1. In DevOps Change Velocity, in the Configure to send data playbook activity, select Configure manually when configuring the tool instance to send data.
      Jira webhook configuration.
      Note:
      You can also access manual configuration from the Jira tool record in DevOps Change Velocity. From the tool record, select Configure > Configure manually.
    2. Copy the Webhook URL field from the ServiceNow instance connection details for Jira.
      Note:
      Select Copy in the appropriate field to copy the value to your clipboard. The field label changes to Copied, but you can copy multiple times.
      Jira configure webhooks manually.
    3. Navigate to:
      • For Jira Server navigate to Administration > System > WebHooks.
      • For Jira Cloud instance, navigate to Settings > System > WebHooks.
    4. Select Create a WebHook.
    5. Enter the details for the webhook.
      Field Description
      Name Enter a name for the webhook.
      Status Select Enabled.
      URL Paste the Webhook URL copied from DevOps Change Velocity.
      • Modify the copied webhook URL to reflect the code capability. For example, https://<your_instance>.service-now.com/api/sn_devops/v2/devops/tool/code?toolId=<your_toolID>?ni.nolog.token=<Secure Token>
      • Append the token to the end of the webhook URL.
      Events Select the events to be tracked.

      For example:

      Events for tracking.
    6. Select Create.
      If you want to test the webhook, see the section on Jira in Test webhooks manually.