Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide details the process of automatically creating You can automatically generate Jira tickets using webhook events from AGILITY. It This feature is intended for users with administrative access Administrative permissions to Jira and AGILITY.

Table of Contents

Prerequisites

  • Access to AGILITY with permissions to set up webhooks.

  • Administrative access permissions to a Jira Project. For more details on Jira permission for managing automations check here

  • Basic familiarity with Jira’s project and automation settings.

...

Configure AGILITY to

...

send Webhook

...

events

...

  1. Log into AGILITY

...

  1. with the necessary permissions.

1.2 Navigate to Webhooks Settings

...

  1. Select Settings > Application Settings > Webhook Configuration.

    Image Modified

...

Set your desired trigger events and input the Jira webhook URL.

  • Set your desired trigger events (i.e analysis_done).

  • Specify the Jira webhook URL (obtained in Jira Step 2).

...

...

  1. Create a new webhook for the desired trigger events.

    Image Added

Generate Webhook URL in Jira

...

  1. Access your target Jira project

...

  1. . Log into your Jira instance

...

  1. using the correct permissions to access Automation settings.

...

  1. Navigate to the Project Settings

...

  1. where you want to create tickets.

    Image Modified

...

  1. Go to Automation

...

  1. settings in your project settings.

    Image Modified

...

  1. Set up an automation rule with "Incoming Webhook" as the trigger and copy the provided URL.

    Image Modified
  2. Choose Incoming Webhook as the trigger.

  3. Jira will provide a unique webhook URL. Copy this URL and use it in Step 1.

  4. Select No issues from the webhook , AGILITY webhook payload only contains JSON data relevant to the event. Use Jira Smart Values to access and manipulate data from the payload.

...

Set Up the Automation Rule in Jira

3.1 Define Trigger

  1. Choose the “Incoming Webhook” trigger you previously created.

    Image Modified

...

  1. Define Conditions (Optional)

...

  1. . Add conditions to filter the webhook events that will create a ticket. For example, you can add a condition to create tickets only for specific types of events.
    In the example below, only Analysis with failed Call Flows will create a ticket.

    Image Modified

3.3 Define Action

  1. Configure the “Create issue” action. Use smart values to fill in the issue fields from the webhook data.

    Image Modified

...

Test the Integration

...

  1. Trigger an Event in AGILITY

...

  1. . Carry out an action in AGILITY that triggers the webhook. For example, create a new Analysis with a PCAP file that contains failures.

...

  1. Verify

...

  1. that a new issue is created in Jira with details from the AGILITY event.
    With rule’s Audit Log you can review to see when the rule was triggered, the final result of the execution, and any actions that may have been performed.

    Image Modified

Tips and Best Practices

  • Implement webhook security.

  • Regularly monitor the automation rules for any errors.

  • Enable or Disable the rule as for your needsneeded.

  • Be mindful of Jira's rate limits.

...