Available values

Available smart-values

{{issue}}

Added by: Most Jira Triggers

The active issue. e.g. the issue created/edited. 

These have the shape defined by Jira's REST interface (see the JSON example). You can access fields like issue type, status and custom fields through the dot notation.

{{issue.key}}
{{issue.status.name}}
{{issue.issuetype.name}}
{{issue.description}}
{{issue.toUrl}}
{{#issue.created}}
    format="dd/MM/yyyy"
{{/}}
{{issue.duedate}}
{{issue.Custom Field.value}}
{{#issue.components}}{{name}}{{/}}

{{issues}}

Added by: Triggers that run a JQL search (e.g. Scheduled or Webhook) or otherwise gather multiple issues.

The list of issues returned by trigger, each in the same form as single issues. See below for how to work with lists.

{{#issues}}{{.}}{{/}}

{{issue.comments}}

The list of comments for the issue.

{{#issue.comments}}{{body}}{{/}}
{{#issue.comments}}{{author}}{{/}}
{{#issue.comments}}{{created}}{{/}}
{{issue.comments.last.body}}

{{issue.parent}}

If this issue is a sub-task, then parent refers to the parent issue. You can access all fields of the parent.

{{issue.parent.key}}
{{issue.parent.priority.name}}
{{issue.parent.Epic Link}}
{{issue.parent.epic.summary}}

{{issue.properties}}

Here you can access any issue property. Properties are frequently used by add-ons and integrations to store values.

{{issue.properties.some.value}}

{{issue.watchers}}

You can access the current watchers of an issue.

{{issue.watchers.displayName}}
{{issue.watchers.emailAddress}}

{{issue.epic}}

Added by: This is added any time an issue is added

If this issue is in an Epic, then epic refers to the Epic issue. You can access all fields of the Epic.

{{issue.epic.key}}
{{issue.epic.status.name}}
{{issue.epic.My Custom Field}}

{{issue.latest}}

This re-fetches the latest state of the issue from Jira.

In generally this should not be used since it requires an expensive reload of issue data. The only situation where this is necessary, is where subsequent actions need to have visibility of the latest state of the issue (e.g. 2 edit issue actions that need to 'add' to the value of a field instead of overwriting it).

{{issue.latest.description}}

{{issue.security.name}}

The text of the security level.

{{issue.security.name}}
{{issue.security.id}}

{{triggerIssue}}

Added by: The Related Issues Action.

The refers to the original issue when you branch the chain.

{{triggerIssue.description}}

... all fields available to {{issue}} are available as well.

{{reporter}}

Added by: Most Jira Triggers.

The reporter of the active issue

{{reporter.key}}
{{reporter.name}}
{{reporter.displayName}}
{{reporter.emailAddress}}
{{reporter.timeZone}}

{{assignee}}

Added by: Most Jira Triggers.

The assignee of the active issue

{{assignee.displayName}}

... (same as reporter)

{{initiator}}

Added by: Most Jira Triggers.

The user who performed the action that triggered the rule

{{initiator.displayName}}
... (same as reporter)

{{comment}}

Added by: Jira Triggers that contain a comment. E.g. Transition issue.

The comment associated with an trigger

{{comment.body}}
{{comment.author}}
{{comment.created}}
{{comment.internal}}

{{comment.internal}} returns true or false for service desk comments.

{{comment.properties}}

Way to access any comment property. Properties are frequently used by add-ons and integrations to store values.

{{comment.properties."sd.public.comment".internal}}

{{changelog}}

Added by: Jira Triggers that edit an issue

All the fields that where changed. Each field is a list of changes. You can access useful things like the previous status during a transition.

{{#changelog.summary}}
  {{toString}}
{{/}}
{{#changelog.issuetype}}
  {{fromString}}
{{/}}
// Previous status name
{{#changelog.status}}{{fromString}}{{/}}
// Previous status id (for using in another Edit action
{{#changelog.status}}{{from}}{{/}}

{{webhookData}}

Added by: Webhook Trigger

The body of the Webhook request

{{webhookData.someValue.childValue}}

{{createdIssues}}

Added by: Clone Issue Action, Create Issue Action, Create Sub-tasks Action

A list of issues that have been created in the rule

{{#createdIssues}}{{key}}{{/}}

{{createdIssue}}

The previous issue created in this rule

{{createdIssue.some field}}

{{eventType}}

The type of event that triggered the rule e.g.: jira:issue_updated :issue_commented

{{eventType}}

{{issue.fixVersions}} {{issue.versions}}

Fix/affects versions of an issue as a list (see accesing multi-value fields).

Properties for versions include: name, description, archived, released, releaseDate

{{issue.fixVersions.first.releaseDate}}
{{issue.versions.first.name}}

{{issue.components}}

Components of an issue as a list. (see accesing multi-value fields)

{{issue.components.first.name}}

{{issue.Request Type}}

Service Desk specific request type object that you can grab useful information from.

// Customer request type:
{{issue.Request Type.requestType.name}} 
// Current JSD status:
{{issue.Request Type.currentStatus.status}}

{{worklog}}

Added by: Worklogged Trigger

The worklog entry that has just been logged against an issue.

{{worklog.comment}}
{{worklog.started}} 
{{worklog.timeSpentSeconds}}
// Cloud only
{{worklog.timeSpent}}
// Visibility is available when the worklog is restricted
{{worklog.visibility}}
{{worklog.visibility.type}}
{{worklog.visibility.value}}

Extracting issue data

With the {{issue...}} value you access all of Jira's field data, based on the issue representation Jira's REST api returns. The syntax for this can be a little bit complicated so here's a few examples.

Assuming your issue has the following JSON representation obtained by visiting https://<YOUR-INSTANCE>.atlassian.net/rest/api/2/issue/<YOUR-ISSUE-KEY>:

sample-issue.json

{
  "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
  "id": "10002",
  "self": "http://www.example.com/jira/rest/api/2/issue/10002",
  "key": "EX-1",
  "names": {
    "watcher": "watcher",
    "attachment": "attachment",
    "sub-tasks": "sub-tasks",
    "description": "description",
    "project": "project",
    "comment": "comment",
    "issuelinks": "issuelinks",
    "worklog": "worklog",
    "updated": "updated",
    "timetracking": "timetracking"
  },
  "schema": {
    
  },
  "fields": {
    "summary": "Hello test issue!",
    "watcher": {
      "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers",
      "isWatching": false,
      "watchCount": 1,
      "watchers": [
        {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        }
      ]
    },
    "attachment": [
      {
        "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
        "filename": "picture.jpg",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "key": "fred",
          "accountId": "99:27935d01-92a7-4687-8272-a9b8d3b2ae2e",
          "name": "fred",
          "avatarUrls": {
            "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
            "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
            "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
            "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
          },
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2017-01-20T00:36:28.642+0000",
        "size": 23123,
        "mimeType": "image/jpeg",
        "content": "http://www.example.com/jira/attachments/10000",
        "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
      }
    ],
    "sub-tasks": [
      {
        "id": "10000",
        "type": {
          "id": "10000",
          "name": "",
          "inward": "Parent",
          "outward": "Sub-task"
        },
        "outwardIssue": {
          "id": "10003",
          "key": "EX-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/EX-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "status": {
      "self": "https://goonbag.atlassian.net/rest/api/2/status/10000",
      "description": "",
      "iconUrl": "https://goonbag.atlassian.net/images/icons/status_generic.gif",
      "name": "To Do",
      "id": "10000",
      "statusCategory": {
        "self": "https://goonbag.atlassian.net/rest/api/2/statuscategory/2",
        "id": 2,
        "key": "new",
        "colorName": "blue-gray",
        "name": "To Do"
      }
    },
    "description": "example bug report",
    "project": {
      "self": "http://www.example.com/jira/rest/api/2/project/EX",
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "avatarUrls": {
        "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
        "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
        "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
        "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
      },
      "projectCategory": {
        "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
        "id": "10000",
        "name": "FIRST",
        "description": "First Project Category"
      }
    },
    "comment": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
        "id": "10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "created": "2017-01-20T00:36:28.593+0000",
        "updated": "2017-01-20T00:36:28.593+0000",
        "visibility": {
          "type": "role",
          "value": "Administrators"
        }
      }
    ],
    "customfield_10700": "Hello sample field",
    "issuelinks": [
      {
        "id": "10001",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "outwardIssue": {
          "id": "10004L",
          "key": "PRJ-2",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-2",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      },
      {
        "id": "10002",
        "type": {
          "id": "10000",
          "name": "Dependent",
          "inward": "depends on",
          "outward": "is depended by"
        },
        "inwardIssue": {
          "id": "10004",
          "key": "PRJ-3",
          "self": "http://www.example.com/jira/rest/api/2/issue/PRJ-3",
          "fields": {
            "status": {
              "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png",
              "name": "Open"
            }
          }
        }
      }
    ],
    "worklog": [
      {
        "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
        "author": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "updateAuthor": {
          "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
          "name": "fred",
          "displayName": "Fred F. User",
          "active": false
        },
        "comment": "I did some work here.",
        "updated": "2017-01-20T00:36:28.801+0000",
        "visibility": {
          "type": "group",
          "value": "jira-developers"
        },
        "started": "2017-01-20T00:36:28.792+0000",
        "timeSpent": "3h 20m",
        "timeSpentSeconds": 12000,
        "id": "100028",
        "issueId": "10002"
      }
    ],
    "updated": 1,
    "timetracking": {
      "originalEstimate": "10m",
      "remainingEstimate": "3m",
      "timeSpent": "6m",
      "originalEstimateSeconds": 600,
      "remainingEstimateSeconds": 200,
      "timeSpentSeconds": 400
    }
  }
}

Examples

Then you can access fields in this way:

Issue Key

  • Smart value: {{issue.key}}
  • Example value: EX-1
  • JSON Path:
{
    ...
    "key": "EX-1",
    ...
}

Summary

  • Smart value: {{issue.summary}}
  • Example value: Hello test issue!
  • JSON Path:
{
    ...
    "key": "EX-1",
    ...
    "fields": {
        "summary": "Hello test issue!"
        ...
    }
}

Status name

  • Smart value: {{issue.status.name}}
  • Example value: To Do
  • JSON Path:
{
    ...
    "key": "EX-1",
    ...
    "fields": {
        ...
        "status": {
            ...
            "name": "To Do",
            ...
            "statusCategory": {
                ...
            }
        },
        ...
    }
}

All attachment file names

  • Smart value: {{#issue.attachment}}{{filename}},{{/}}
  • Example value: picture.jpg,log.txt
  • JSON Path:
{
    ...
    "key": "EX-1",
    ...
    "fields": {
        ...
        "attachment": [
            {
                ...
                "filename": "picture.jpg",
                "author": {...},
                ...
            },
            {
                ...
                "filename": "log.txt",
                "author": {...},
                ...
            }
        ],
        ...
    }
}

"Sample text" custom field (text custom field)

  • Smart value: {{issue.customfield_10700}} or {{issue.Sample text}}
  • Example value: Hello sample field
  • JSON Path:
{
    ...
    "key": "EX-1",
    ...
    "fields": {
        ...
        "customfield_10700": "Hello sample field",
        ...
    }
}