Page Comparison

With This guide explains how to configure Easy Integration's Issue Listeners, you can integrate your Jira with your internal/external systems by calling REST services accordingly. On this page, you will find out how to define a listener and configure the REST service. to call external REST services when specific issue events occur in your Jira projects. By following these steps, you can integrate your internal and external systems to automate workflows and improve data exchange.

Accessing listeners

Listeners can be accessed within Easy Integration's admin UI (Jira admin cog icon > Manage apps > Easy Integrations Menu > Listeners (EI)).  Image Removed

...

The above This page shows displays all the existing listeners that you have already defined. You can alsoperform the following actions:

1. Create a new listener.

2. Edit an existing listener.

3. Delete an existing listener.

...

Step 1: Create a

...

new listener

1. Click on the Add New Listener button.

2. Fill in the information about the listener .details:

...

1. Image Added
   Create

   • Name: Assign a descriptive name for

   the

   • your listener.

   • Projects: Select the specific projects

   that

   • where you want to

   listen out for

   • monitor issue events

   and call REST services

   • . You can also choose

   the 

   • All Projects

   optionAll

   • .

   Similarly, select issue types. You can also choose the 

   • Issue Types

    option.

   • : Select the issue

   event(s) which

   • types you want to listen to

   . You can select multiple issue events.

...

1. • , or choose All Issue Types.

   • Issue Events: Select one or more issue events that trigger the listener.

Step 2: Add a condition

In this part, you can add a condition for the listener. 

...

By default, it only has the return true statement, which means that the listener will execute the REST call. However, you can type your own script in order to programmatically add a condition to execute the REST service or not.

Image Removed
Below is a sample code snippet for a condition that checks the logged-in user should be the reporter of the issue:

Execute Code

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.user.ApplicationUser

ApplicationUser currentUser = ComponentAccessor.getJiraAuthenticationContext().loggedInUser
log.info("current user:" + currentUser.username)
def reporter = issue.reporter.username
log.info("reporter: " + reporter)
return reporter.equals(currentUser.username)

...

Step 3: Fill in REST service details

In this part, REST details (URL, method, headers, body, credential, etc.) are created.

...

1. URL – The endpoint of the REST service. You can type any dynamic parameter here using double curly braces. (e.g. httpfor example, http://mycompany.com/api/book/{{bookId}} assuming bookId is defined within the Parameters section which is described below.

   Image Added

2. Method – Select the Http HTTP Method (GET, POST, PUT, DELETE).

3. Headers – Define your HTTP header key/value sets in separate lines (as shown in the screenshot).

4. Request Body – Type the JSON request body - you body—you can use dynamic parameters here as well. Note that , If if send attachments is selected, the request body must be in a form-data format where key-value pairs can be defined. Check the code block below.:

Request Body form-data

table_name = incident 
table_sys_id = d71f7935c0a8016700802b64c67c11c6

5. Parameters – Define all your dynamic parameters

...

5. . You can add static values as well as the dynamic values of fields/custom fields in the Jira issue. Below are some sample usages.

6. Choose the authorization type. Currently, BASIC Authentication is supported. If you choose the Basic Authorization Type, the credential will become active and the credentials you defined in the Credentials section will be listed.

Headers code example:

Headers

Accept=application/json

Request body Body code example:

Request Body

{
   "item"  : "{{productName}}",
   "price" : "{{price}}",
   "date"  : "{{date}}",
   "item"  : "{{productName}}",
   "owner" : "{{user.displayName}}"
}

Parameters code example:

Parameters

assignee    = $issue.assignee or {{issue.assignee}}
reporter    = {{issue.reporter}}
date        = $issue.created
formattedDate = $DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm").format($issue.created)
productName = $issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11100'))
price       = $issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11102'))
displayName = $user.displayName
userDisplayName = $ComponentAccessor.getUserManager().getUserByName("someUser").getDisplayName() // you can also use ComponentAccessor
comment     = $comment // this is the comment that is passed through the transition

For more details on parameter assigning and utils, see the Parameters Usage Examples page.
Also, see ComponentAccessor, User, Issue, and Status API for all properties and methods.

Step 4: Run asynchronously

...

(Optional)

...

In this section, you can enable async Async to execute the REST service asynchronously. There are a couple of reasons why you may want to execute asynchronously.

...

• Executing synchronously makes the user wait for the transition

...

• longer than usual. If

...

• the REST service host responds late or there is a connection

...

• timeout between the Jira server and the host, the user will wait for the spinner for a long time. So, it may be wise to enable async if your REST service responds slowly.

• Some issue parameters may wait for calculation or reindexing. Some plugins may work in the background to populate the actual result of a custom field and you may want to use that value. 

There is a scheduled task named Easy Integrations for Jira - Async Rest Caller Sched.

...

Step 5: Update custom field (Optional)

In this section, you will find out how to update a custom field based on a value in the REST response.

...

1. First, tick the Updatecustom field checkbox.

2. Select the custom field that you want to update from the drop-down menu.

3. Type the jsonpath JSONPath accordingly to select the value. If the result is not JSON and you want to update a custom field with the body itself, just leave this textbox empty.

See the jsonpath JSONPath examples page for jsonpath samples.

Step 5: Send

...

attachments

In this section, you will find out how to send attachments with REST callcalls.Image Removed

...

1. First, tick the Send Attachments checkbox.

2. Write the name of the form-data parameter name that contains attachments. For instance, in Jira REST Api API for attachments, this name must be "file" , and in ServiceNow REST API, this name must be "uploadFile".

3. Write a groovy script that returns attachments. These attachments will be sent with the REST Callcall. If the script is empty, then all attachments will be sent.

Send Attachments

import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.issue.AttachmentManager;

AttachmentManager attachmentManager = ComponentAccessor.getAttachmentManager();
def attachments = attachmentManager.getAttachments(issue);
return attachments;