REST calls with issue events

This page is about Easy Integrations for Jira DC. Using Jira Cloud? Click the Cloud button above.

This guide explains how to configure Easy Integration's Issue Listeners 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.

On this page: 1 Accessing listeners 2 Step 1: Create a new listener 3 Step 2: Add a condition 4 Step 3: Fill in REST service details 5 Step 4: Run asynchronously (Optional) 6 Step 5: Update custom field (Optional) 7 Step 5: Send attachments

On this page: 1 Accessing listeners 2 Step 1: Create a new listener 3 Step 2: Add a condition 4 Step 3: Fill in REST service details 5 Step 4: Run asynchronously (Optional) 6 Step 5: Update custom field (Optional) 7 Step 5: Send attachments

Accessing listeners

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

This page displays all existing listeners. You can perform the following actions:

Create a new listener.
Edit an existing listener.
Delete an existing listener.

Step 1: Create a new listener

Click the Add New Listener button.
Fill in the listener details:
- Name: Assign a descriptive name for your listener.
- Projects: Select the specific projects where you want to monitor issue events. You can also choose All Projects.
- Issue Types: Select the issue types you want to listen to, 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 to programmatically add a condition to execute the REST service or not.

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.

URL – The endpoint of the REST service. You can type any dynamic parameter here using double curly braces. (for example, http://mycompany.com/api/book/{{bookId}} assuming bookId is defined within the Parameters section which is described below.
Method – Select the HTTP Method (GET, POST, PUT, DELETE).
Headers – Define your HTTP header key/value sets in separate lines.
Request Body – Type the JSON request body—you can use dynamic parameters here as well. Note that 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

Parameters – Define all your dynamic parameters. You can add static values as well as the dynamic values of fields/custom fields in the Jira issue. Below are some sample usages.
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 code example:

Request Body

Parameters code example:

Parameters

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

First, tick the Update custom field checkbox.
Select the custom field that you want to update from the drop-down menu.
Type the 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 examples page for samples.

Step 5: Send attachments

In this section, you will find out how to send attachments with REST calls.

First, tick the Send Attachments checkbox.
Write the name of the form-data parameter name that contains attachments. For instance, in Jira REST API for attachments, this name must be file, and in ServiceNow REST API, this name must be uploadFile.
Write a groovy script that returns attachments. These attachments will be sent with the REST call. If the script is empty, then all attachments will be sent.

Send Attachments