Webhook Event Data Samples

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.

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

Index

Index
1 Worklog Created 2 Attachment Created 3 Issue Link Created 4 Project Created 5 Version Released 6 User Created 7 Voting Option Changed 8 Sprint Created 9 Board Created 10 Jira Expressions Evaluation Failed

Worklog Created

{
  "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

{
  "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

{
  "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

Version Released

User Created

Voting Option Changed

Sprint Created

Board Created

Jira Expressions Evaluation Failed

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