Documentation

Webhook

A webhook is a standard mechanism for an add-on to listen to in-product events via HTTP callbacks. An add-on can register a webhook in the Atlassian Connect descriptor to listen to events that are fired by JIRA or Confluence.

Just to give you an idea of how you can use them in add-ons, here are a few sample webhook events:

  • When an add-on is enabled or disabled
  • When an issue is created or closed in JIRA
  • When a page is created or updated in Confluence
  • An attachment is viewed in Confluence

If your add-on uses webhooks, you must declare the "read" scope in your atlassian-connect.json descriptor.

Handling the webhook event

To receive webhook events, your add-on needs to include the webhook module declaration in its JSON descriptor. The declaration indicates the add-on relative URL at which it will receive the notification. In other words, the Atlassian application will send an HTTP POST to this resource in response to an application event. The add-on code that handles the POST should process any information passed in the body of the message, as appropriate. Each webhook POST sent to the add-on will also include the authentication headers that allow the add-on to validate the authenticity of that request. Specifically, the JWT token can be found in the "Authorization" HTTP header.

Note that if using Apache and mod_wsgi to serve files to a Django application, the Authentication header is stripped out by default. Extra configuration is required to ensure the Authentication header is visible.

Important: It must be noted that webhook delivery is not guaranteed; it is best effort. When a webhook event is triggered in JIRA or Confluence instance then a single HTTP POST is sent to your add-on. If your add-on is down, or there is any network problems between the Atlassian product and your add-on, then you will never receive the webhook event. In general, webhooks are quite reliable; however you must always keep in mind that delivery is not guaranteed.

Variable Substitution

JIRA webhooks also provide a way to add and substitute variables in the url. This is similar to context parameters for add-ons. See context parameters.

For example, if we register to listen for one of the project events with a url containing ${project.id}, a POST message will be sent to the address with the ${project.id} replaced by the id of the project that the event was triggered for.

Webhook event types

Below is a list of all available webhook events.

Add-on and system events

  • connect_addon_disabled
  • connect_addon_enabled

Issue events

  • jira:issue_created
  • jira:issue_deleted
  • jira:issue_updated
  • jira:worklog_updated

    Context parameters are ${project.id}, ${project.key}, ${issue.key}, ${issue.id}.

    Note, worklogs and comments will soon be removed from the callbacks for these events. jira:worklog_updated has also been deprecated. See the notice.

Version events

  • jira:version_created
  • jira:version_deleted
  • jira:version_merged
  • jira:version_updated
  • jira:version_moved
  • jira:version_released
  • jira:version_unreleased

    Context parameters are ${project.id}, ${project.key}, ${version.id}.

    Special context parameter for version_merged event is ${mergedVersion.id}.

Project events

  • project_created
  • project_updated
  • project_deleted

    Context parameters are ${project.id}, ${project.key}

User events

  • user_created
  • user_deleted
  • user_updated

    Context parameters: ${modifiedUser.name}, ${modifiedUser.key}

Feature status events

  • option_voting_changed
  • option_watching_changed
  • option_unassigned_issues_changed
  • option_subtasks_changed
  • option_attachments_changed
  • option_issuelinks_changed
  • option_timetracking_changed

Confluence Webhook events

  • attachment_created
  • attachment_removed
  • attachment_restored
  • attachment_trashed
  • attachment_updated
  • attachment_viewed
  • blog_created
  • blog_removed
  • blog_restored
  • blog_trashed
  • blog_updated
  • blog_viewed
  • blueprint_page_created
  • comment_created
  • comment_removed
  • comment_updated
  • connect_addon_disabled
  • connect_addon_enabled
  • content_permissions_updated
  • group_created
  • group_removed
  • label_added
  • label_created
  • label_deleted
  • label_removed
  • login
  • login_failed
  • logout
  • page_children_reordered
  • page_created
  • page_moved
  • page_removed
  • page_restored
  • page_trashed
  • page_updated
  • page_viewed
  • search_performed
  • space_created
  • space_logo_updated
  • space_permissions_updated
  • space_removed
  • space_updated
  • theme_enabled
  • user_created
  • user_deactivated
  • user_followed
  • user_reactivated
  • user_removed

Example request


 POST /jira-issue_created?user_id=admin&user_key=admin HTTP/1.1
 Authorization: JWT ...
 Atlassian-Connect-Version: x.x
 Content-Type: application/json
 {
   timestamp: 1426661049725,
   webhookEvent: 'jira:issue_created',
   ...
 }
 

Example responses

All webhooks will post JSON data to the listening add-on. The structure of this JSON differs based on the Atlassian product that sent the event and the event itself. Here are some example webhook events:

JIRA issue-related webhook event structure

All webhook events that are sent because of JIRA issue updates will have the following structure.


 {
   "timestamp"
   "event"
   "user": {
     // See User shape in the linked document
   },
   "issue": {
     // See Issue shape in the linked document
   },
   "changelog" : {
     // See Changelog shape in the linked document
   },
   "comment" : {
     // See Comment shape in in the linked document
   }
 }
 

This is fully documented in Webhooks: Example callback for an issue-related event.

Confluence page_created


 {
   "page": {
     "spaceKey": "~admin",
     "modificationDate": 1471926079631,
     "creatorKey": "ff80808154510724015451074c160001",
     "creatorName": "admin",
     "lastModifierKey": "ff80808154510724015451074c160001",
     "self": "https://cloud-development-environment.atlassian.net/wiki/display/~admin/Some+random+test+page",
     "lastModifierName": "admin",
     "id": 16777227,
     "title": "Some random test page",
     "creationDate": 1471926079631,
     "version": 1
   },
   "user": "admin",
   "userKey": "ff80808154510724015451074c160001",
   "timestamp": 1471926079645,
   "username": "admin"
 }
 

Confluence comment_created


 {
   "comment": {
     "spaceKey": "~admin",
     "parent": {
       "spaceKey": "~admin",
       "modificationDate": 1471926079631,
       "creatorKey": "ff80808154510724015451074c160001",
       "creatorName": "admin",
       "lastModifierKey": "ff80808154510724015451074c160001",
       "self": "https://cloud-development-environment.atlassian.net/wiki/display/~admin/Some+random+test+page",
       "lastModifierName": "admin",
       "id": 16777227,
       "title": "Some random test page",
       "creationDate": 1471926079631,
       "version": 1
     },
     "modificationDate": 1471926091465,
     "creatorKey": "ff80808154510724015451074c160001",
     "creatorName": "admin",
     "lastModifierKey": "ff80808154510724015451074c160001",
     "self": "https://cloud-development-environment/wiki/display/~admin/Some+random+test+page?focusedCommentId=16777228#comment-16777228",
     "lastModifierName": "admin",
     "id": 16777228,
     "creationDate": 1471926091465,
     "version": 1
   },
   "user": "admin",
   "userKey": "ff80808154510724015451074c160001",
   "timestamp": 1471926091468,
   "username": "admin"
 }
 

Inspecting webhook contents

Each type of webhook event includes information specific to that event in the body content of the POST message. The add-on resource that listens for webhook posts should receive and process the content as appropriate for the add-on. To understand what type of content each webhook generates, you can use the Connect inspector tool.

The Connect inspector is a service that generates temporary Atlassian Connect add-on's that you can install in your development environment to inspect the content of event messages. The Connect inspector subscribes to every webhook event type available on the running instance of the Atlassian application, and prints the body posted by the instance to your web browser.

Example

{
  "modules": {
    "webhooks": [
      {
        "event": "jira:issue_created",
        "url": "/issue-created"
      }
    ]
  }
}

Properties

event

Type
string
Required
Yes
Description

Specifies the named event you would like to listen to (e.g., "enabled", "jira:issue_created", etc.)

url

Type
string

uri-template
Required
Yes
Description

Specifies your add-on's POST webhook handler URL. This property must be a URL relative to the add-on's baseUrl.

params

Type
object
Description

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}