Integrations Hub for Jira allows custom variables that can be used when generating an integration request. Under the hood, we're using JSONPath and Mustache to extract and substitute variables for integration request.

It's currently possible to substitute the following:

• Request URL

• Request headers

• Request body

• Request Authorization

General usage

Variables are accessed by using the curly braces notation of Mustache. 

{{variable_name}} or for an object, the dot notated getter name without the "get".

Example: {{my_object.name}} . For the value of the getName() of the my_object variable

Value variables (Primitives/Strings ie.)

{{variable}} - Substitutes the variable value

Objects

{{object_name.user.name}} - Substitutes the object_name getUser().getName() value

Collections

Iterate through lists using the following Mustache pattern:

{{#title}}{{.}}{{/title}}

See Manage Arrays for further info

Formatting dates

Date objects can be formatted by using the following syntax. {{#date}}{{#format}}java_date_format_pattern{{/format}}{{/date}}

Example:

{{#issue.updated}} {{#format}} yyyy-MM-dd {{/format}} {{/issue.updated}} - Will format issue updated date. (since v.3.8.0)

Quick Formats (since v 4.4.0)

{{now.yearMonthDay}} = YYYY-MM-DD

{{now.monthDayYear}} = MM/DD/YYYY

{{now.monthDayYear2}} = MM/DD/YY

{{now.dayMonthYear}} = DD-MM-YYYY

Default variables

Default variables that are available for every iHub integration request are:

String manipulation

Make a variable lowercase or uppercase

Lowercase
"name":"{{issue.key.toLowerCase}}"
Uppercase
"name":"{{issue.key.toUpperCase}}"
Trim
"name":"{{issue.key.trim}}"

Defining custom variables from a response

You may define any number of variables from the response of the parent iHub integration that will be available for usage within the child's variable scope. 

Define custom variables by defining them in the variables section of the child action.

Set the variable name followed by the JSONPath expression.

See JSONPath for tutorials examples on how to define your JSON path for your use case

Automatic response variables

{
      "gender": "male",
      "name": {
        "title": "mr",
        "first": "sal",
        "last": "van ballegooij"
      },
      "location": {
        "street": "1978 predikherenstraat",
        "city": "oldenzaal",
        "state": "groningen",
        "postcode": 32432,
        "coordinates": {
          "latitude": "46.8524",
          "longitude": "-179.9888"
        },
        "timezone": {
          "offset": "+5:00",
          "description": "Ekaterinburg, Islamabad, Karachi, Tashkent"
        }
      }
}

Issue object

Parent object

Using variables

More variables

scope.name

import com.fasterxml.jackson.databind.ObjectMapper
ObjectMapper mapper = new ObjectMapper()
//response is passed in from the parent action
def myRespnse = mapper.readValue(response, HashMap.class)

def myList = []
myList.add([email:issue.reporter.emailAddress])
return mapper.writeValueAsString(myList)