Message format for JIRA Cloud

Owned by J Soft
Last updated: Apr 28, 2017
2 min read
Basic format
{
  "text":"${eventType} ${issueLink} in ${projectLink} by ${userLink}"
}

New format

{
  "text":"<eventType> <issueLink> in <projectLink> by <userLink>"
}
Advance format
{
  "text":"${eventType} ${issueLink} in ${projectLink} by ${userLink}",
  "attachments": [
    {
      "color": "#205081",
      "text": "${eventMessageBody}",
      "fields": [
        {
          "title": "Type",
          "value": "${issueType}",
          "short": true
        },
        {
          "title": "Assignee",
          "value": "${issueAssignee}",
          "short": true
        },
        {
          "title": "Creator",
          "value": "${issueCreator}",
          "short": true
        }
      ]
    }
  ]
}

New format

{
  "text":"<eventType> <issueLink> in <projectLink> by <userLink>",
  "attachments": [
    {
      "color": "#205081",
      "text": "<eventMessageBody>",
      "fields": [
        {
          "title": "Type",
          "value": "<issueType>",
          "short": true
        },
        {
          "title": "Assignee",
          "value": "<issueAssignee>",
          "short": true
        },
        {
          "title": "Creator",
          "value": "<issueCreator>",
          "short": true
        }
      ]
    }
  ]
}

Metadata

KeyDescriptionExample data

${eventType}

<eventType>


E.g : "New issue created"
${issueLink}
<issueLink>
It uses issue summary for displaying
${issueKeyLink}
<issueKeyLink>
It uses issue key for displaying

${issueKey}

<issueKey>
<issue.key>
This is issue keye.g : TEST-1

${issueSummary}

<issueSummary>

<issue.fields.summary>

This is issue summarye.g : Cannot find attachment

<issue.fields.project.key>

<issue.fields.project.name>

Project meta data

JS

Support

${projectLink}
<projectLink>
This is project link

<user.key>

<user.emailAddress>

<user.displayName>

Action user meta data
${userLink}
<userLink>
It is action user on issue
${eventMessageBody}
<eventMessageBody>
issue description or comment
${issueAttachments}
<issueAttachments>
number of attachments in issue
${issueAssignee}
<issueAssignee>
<issue.fields.assignee.displayName>
current assignee
${issueCreator}
<issueCreator>
<issue.fields.creator.displayName>
issue creator
${issueResolution}
<issueResolution>
Fixed, Won't Fix ... . You can define resolution data in JIRA
${issueResolutionDate}
<issueResolutionDate>


${issueDueDate}
<issueDueDate>


${issueStatus}
<issueStatus>
"Done,Open"
${issueLabels}
<issueLabels>
"Bug,Improvement,Feedbacks"
${issueType}
<issueType>
e.g : Task, Story, Epic, Subtask

<comment.body>

<comment.created>

<comment.updated>

<comment.author.displayName>

<comment.updateAuthor.displayName>

Comment metadata
<issueComponents>e.g : Development,Front End

Screenshot