Page Comparison

Button handy

blank	false
color	#0052CC
name	Cloud
link	https://appfire.atlassian.net/wiki/spaces/EIFJC/pages/10125437/Installation
width	84

Button handy

blank	false
color	#EBECF0
name	On-Prem
link	https://appfire.atlassian.net/wiki/spaces/EI4J/pages/11206868/Installation
width	85

Panel

panelIconId	atlassian-info
panelIcon	:info:
bgColor	#F4F5F7

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

...

This documentation provides sample data for various webhook events in Jira. These event samples offer insight into the format and content of webhook payloads.

Please use these sample event data to understand the structure of webhook payloads in Jira for various events. The actual data for your instance may differ but should follow a similar structure.

Panel

panelIconId	atlassian-check_mark
panelIcon	:check_mark:
bgColor	#F4F5F7

Refer to the Events Not Supported by JQL document for an example and the list of the JQL not supported type of events.

🎯 Index

Table of Contents

minLevel	3
maxLevel	6
outline	false
type	list
printable	false

Worklog Created

Code Block

language	js

{
  "timestamp": 1642152961827,
  "webhookEvent": "worklog_created",
  "worklog": {
    "self": "https://test-jira.atlassian.net/rest/api/2/issue/10027/worklog/10000",
    "author": {
      "self": "https://test-jira.atlassian.net/rest/api/2/user?accountId=06hv321a334o9391719345qr",
      "accountId": "06hv321a334o9391719345qr",
      "avatarUrls": {
        "48x48": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "24x24": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "16x16": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "32x32": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png"
      },
      "displayName": "Test User",
      "active": true,
      "timeZone": "Europe/Istanbul",
      "accountType": "atlassian"
    },
    "updateAuthor": {
      "self": "https://test-jira.atlassian.net/rest/api/2/user?accountId=06hv321a334o9391719345qr",
      "accountId": "06hv321a334o9391719345qr",
      "avatarUrls": {
        "48x48": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "24x24": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "16x16": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "32x32": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png"
      },
      "displayName": "Test User",
      "active": true,
      "timeZone": "Europe/Istanbul",
      "accountType": "atlassian"
    },
    "comment": "",
    "created": "2022-01-14T12:36:01.827+0300",
    "updated": "2022-01-14T12:36:01.827+0300",
    "started": "2022-01-11T12:29:22.229+0300",
    "timeSpent": "1w 4d 6m",
    "timeSpentSeconds": 259560,
    "id": "10000",
    "issueId": "10027"
  }
}

Attachment Created

Code Block

language	js

{
  "timestamp": 1642165011439,
  "webhookEvent": "attachment_created",
  "attachment": {
    "self": "https://test-jira.atlassian.net/rest/api/2/attachment/10004",
    "id": "10004",
    "filename": "jov-division-unknown-pleasures.jpeg",
    "author": {
      "self": "https://test-jira.atlassian.net/rest/api/2/user?accountId=06hv321a334o9391719345qr",
      "accountId": "06hv321a334o9391719345qr",
      "avatarUrls": {
        "48x48": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "24x24": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "16x16": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "32x32": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png"
      },
      "displayName": "Test User",
      "active": true,
      "timeZone": "Europe/Istanbul",
      "accountType": "atlassian"
    },
    "created": "2022-01-14T15:56:51.439+0300",
    "size": 125444,
    "mimeType": "image/jpeg",
    "content": "https://test-jira.atlassian.net/secure/attachment/10004/jov-division-unknown-pleasures.jpeg",
    "thumbnail": "https://test-jira.atlassian.net/secure/thumbnail/10004/jov-division-unknown-pleasures.jpeg"
  }
}

...

Issue Link Created

Code Block

language	js

{
  "timestamp": 1642164912495,
  "webhookEvent": "issuelink_created",
  "issueLink": {
    "id": 10010,
    "sourceIssueId": 10052,
    "destinationIssueId": 10027,
    "issueLinkType": {
      "id": 10000,
      "name": "Blocks",
      "outwardName": "blocks",
      "inwardName": "is blocked by",
      "isSubTaskLinkType": false,
      "isSystemLinkType": false
    },
    "systemLink": false
  }
}

Project Created

Code Block

language	js

{
  "timestamp": 1642374378042,
  "webhookEvent": "project_created",
  "project": {
    "self": "https://test-jira.atlassian.net/rest/api/2/project/10003",
    "id": 10003,
    "key": "TEST1",
    "name": "test122",
    "avatarUrls": {
      "48x48": "https://test-jira.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10421",
      "24x24": "https://test-jira.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10421?size=small",
      "16x16": "https://test-jira.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10421?size=xsmall",
      "32x32": "https://test-jira.atlassian.net/rest/api/2/universal_avatar/view/type/project/avatar/10421?size=medium"
    },
    "projectLead": {
      "self": "https://test-jira.atlassian.net/rest/api/2/user?accountId=06hv321a334o9391719345qr",
      "accountId": "06hv321a334o9391719345qr",
      "avatarUrls": {
        "48x48": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "24x24": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "16x16": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png",
        "32x32": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-5.png"
      },
      "displayName": "Test User",
      "active": true,
      "timeZone": "Europe/Istanbul",
      "accountType": "atlassian"
    },
    "assigneeType": "admin.assignee.type.unassigned"
  }
}

Version Released

Code Block

language	js

{
  "timestamp": 1642375672181,
  "webhookEvent": "jira:version_released",
  "version": {
    "self": "https://test-jira.atlassian.net/rest/api/2/version/10000",
    "id": "10000",
    "description": "test123descr",
    "name": "test123",
    "archived": false,
    "released": true,
    "releaseDate": "2022-01-17",
    "overdue": false,
    "userReleaseDate": "17/Jan/22",
    "projectId": 10000
  }
}

User Created

Code Block

language	js

{
  "timestamp": 1642379710275,
  "webhookEvent": "user_created",
  "user": {
    "self": "https://test-jira.atlassian.net/rest/api/2/user?accountId=06hv321a334o9391719345qr",
    "accountId": "06hv321a334o9391719345qr",
    "avatarUrls": {
      "48x48": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-0.png",
      "24x24": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-0.png",
      "16x16": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-0.png",
      "32x32": "https://secure.gravatar.com/avatar/06hv321a334o9391719345qr?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FEA-0.png"
    },
    "displayName": "Test User",
    "active": true,
    "timeZone": "Europe/Istanbul",
    "accountType": "atlassian"
  }
}

Voting Option Changed

Code Block

language	js

{
  "timestamp": 1642381004508,
  "webhookEvent": "option_voting_changed",
  "property": {
    "self": "https://test-jira.atlassian.net/rest/api/2/configuration",
    "key": "jira.option.voting",
    "value": "false"
  }
}

Sprint Created

Code Block

language	js

{
  "timestamp": 1642382362847,
  "webhookEvent": "sprint_created",
  "sprint": {
    "id": 2,
    "self": "https://test-jira.atlassian.net/rest/agile/1.0/sprint/2",
    "state": "active",
    "name": "Sample Sprint 2",
    "startDate": "2022-01-09T16:09:22.808Z",
    "endDate": "2022-01-23T16:29:22.808Z"
  }
}

Board Created

Code Block

language	js

{
  "timestamp": 1642374377318,
  "webhookEvent": "board_created",
  "board": {
    "id": 2,
    "self": "https://test-jira.atlassian.net/rest/agile/1.0/board/2",
    "name": "TEST1 board",
    "type": "simple"
  }
}

Jira Expressions Evaluation Failed

Note: The payload for this event is not provided as it varies based on the specific expression evaluation failure.

Code Block

language	js

{
  "timestamp": 1562571661978,
  "webhookEvent": "jira_expression_evaluation_failed",
  "expression": "'1' == 1",
  "errorMessages": ["Evaluation failed: \"1 == '1'\" - operator \"==\" is not applicable to types: Number and String"],
  "moduleKey": "module-that-provided-the-expression",
  "condition.id": "bb98deec-4f14-4431-9dbd-fc591cb71f34",
  "validator.id": "bb98deec-4f14-4431-9dbd-fc591cb71f34",
  "workflow.name": "HSP: Project Management Workflow",
  "context": {
    "issue": {
      "id": "10000",
      "key": "HSP-1"
    },
    "project": {
      "id": "10000",
      "key": "HSP"
    },
    "transition": {
      "id": 21,
      "name": "Done",
      "from": {
        "name": "To Do",
        "id": "10000"
      },
      "to": {
        "name": "Done",
        "id": "10001"
      }
    }
  }
}

Version	Old Version 7	New Version Current
Changes made by	Derya Özdemir	Derya Özdemir
Saved on	Oct 05, 2023	Oct 24, 2023

Page Comparison

Versions Compared

Key

Worklog Created

Attachment Created

Issue Link Created

Project Created

Version Released

User Created

Voting Option Changed

Sprint Created

Board Created

Jira Expressions Evaluation Failed