Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

Prerequisites

  • Access to AGILITY with permissions to set up webhooks.

  • Administrative access to Jira.

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

Step 1: Configure AGILITY to Send Webhook Events

1.1 Log into AGILITY

Begin by logging into your AGILITY account with the necessary permissions.

1.2 Navigate to Webhooks Settings

Go to the settings area in AGILITY and find the section for webhooks.

1.3 Create a New Webhook

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

Step 2: Generate Webhook URL in Jira

2.1 Open Jira

Log into your Jira instance with administrative rights.

2.2 Navigate to Project Settings

Access the settings of the project where you want to create tickets.

2.3 Go to Automation

Locate the Automation section in the project settings.

2.4 Create a New Rule

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

  • Choose Incoming Webhook as the trigger.

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

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

Step 3: Set Up the Automation Rule in Jira

3.1 Define Trigger

Choose the “Incoming Webhook” trigger you previously created.

3.2 Define Conditions (Optional)

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.

3.3 Define Action

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

Step 4: Test the Integration

4.1 Trigger an Event in AGILITY

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

4.2 Verify in Jira

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

Tips and Best Practices

  • Implement webhook security.

  • Regularly monitor the automation rules for any errors.

  • Enable or Disable the rule as for your needs

  • Be mindful of Jira's rate limits.

  • No labels