Atlassian Connect Framework to build add-on for the JIRA and Confluence

v1.2.4 2018-09-05 15:04 UTC


Latest Version on Packagist Software License Build Status Quality Score Total Downloads

Atlassian Connect Framework to build add-ons for the JIRA and Confluence


  • Laravel 5.5
  • PHP ~7.0

Getting Started


Install dependency via Composer

$ composer require brezzhnev/atlassian-connect-core

Register route middleware jwt by adding to app\Http\Kernel.php the following line:

'jwt' => \AtlassianConnectCore\Http\Middleware\JWTAuth::class

Set authentication driver to jwt in config/auth.php:

'guards' => [
    'web' => [
        'driver' => 'jwt',
        'provider' => 'users',

Set model class in config/auth.php providers section:

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => \AtlassianConnectCore\Models\Tenant::class,

Register the subscriber in the app/Providers/EventServiceProvider.php:

 * The subscriber classes to register.
 * @var array
protected $subscribe = [

Configure database and run the following:

php artisan migrate
php artisan plugin:install

The command php artisan plugin:install will publish config, views and resources that you can change for your needs.

Also, it will create "dummy" tenant needed for local testing and development without the need of installing the add-on in real JIRA or Confluence instance.

Get it working

If your application returns the add-on descriptor on the request to URL http://localhost:8000/atlassian-connect.json it means you are close to happiness and you can install the add-on.

Firstly, you need to enable the development options. Go to the "Manage add-ons" page. You'll see the link "Settings" at bottom of the page. After clicking you'll see two checkboxes that must be selected. Apply your changes.

For installing the add-on in the instance, the last one should see your server. If you are working locally the easiest way is to use ngrok.

After you are visible in the worldwide you should put your actual website URL to environment variable PLUGIN_URL. Also, you need to configure your add-on by editing the file config/plugin.php. Most values may be overwritten using env vars.

Then you need to upload the add-on. Click "Upload add-on" and paste your public URL with descriptor path, eg. or

Note: HTTPS is required

After successfully installing you can see "Your add-on" top menu item (in case of JIRA). You also can go to the add-on general page by direct link :product_base_url/plugins/servlet/ac/sample-plugin/hello-page

Instead :product_base_url you should put your JIRA or Cofluence instance URL (eg.

If you see page working, the application configured and add-on installed correctly.

Publish resources

Instead of using plugin:install you can perform actions manually.

To copy all the publishes you should use the following command:

php artisan vendor:publish --provider="AtlassianConnectCore\ServiceProvider"

To copy only specific publish you must call this command with option --tag. The value can be public (to copy assets), views and config.


Add-On Configuration

After copying publishes you can see the file config/plugin.php in your application. Please, use this configuration file to change add-on properties.

Default routes

The following routes are registered by default:

  • GET /atlassian-connect.json descriptor contents
  • POST /installed add-on installed callback
  • POST /uninstalled add-on uninstalled callback
  • POST /enabled add-on enabled callback
  • POST /disabled add-on disabled callback
  • GET /hello sample page to persuade all working correctly

You can disable them by setting to false config value plugin.loadRoutes.


You can use Descriptor facade to customize or create from scratch your own descriptor contents.

For example, you can customize it by adding to the app\Providers\AppServiceProvider in boot section the following:

Descriptor::base() // base descriptor contents
    ->setScopes(['admin' , 'act_as_user'])
        'webhooks' => [[
            'event' => 'jira:issue_created',
            'url' => route('webhookHandlerRouteName')
    ->set('version', $this->getLatestPluginVersion());

Warning: if you are using route helper in the AppServiceProvider you should have RouteServiceProvider defined above AppServiceProvider in your app.php config.

Performing requests

In most cases of add-on development for Atlassian Product you need to perform requests to the instance.

For this case you can use JWTClient. It uses GuzzleHttp as HTTP client.

If you want to have custom handling (middlewares etc.) you can pass client instance to the constructor.


If you want to send a request to an endpoint with pagination you should use JWTClient::paginate method. In most cases you don't need to pass paginator instance to the JWTClient constructor because it will instantiate automatically by resolving your Tenant product type (JIRA or Confluence), but you always can use specific paginator.

There are two paginators:

  • JiraPaginator
  • ConfluencePaginator

Of course you can extend Paginator class and create your own.


Get a Confluence page content

use AtlassianConnectCore\Http\Clients\JWTClient;


public function pageContent(int $id): array
    $client = new JWTClient($this->tenant); // or Auth::user() if you performing a request from the instance
    return $client->get('rest/api/content/ . $id', [
        'query' => [
            'expand' => ''

Get a JIRA issue

use AtlassianConnectCore\Http\Clients\JWTClient;


public function viewIssue(string $key): array
    $client = new JWTClient($this->tenant);
    return $client->get('rest/api/2/issue/ . $key');


The plugin provides a way to handle incoming webhooks, it uses Laravel Events so you can use habitual way to use them.

If you don't familiar with Laravel Events, please take a look at Laravel Docs

There are two ways to define webhook listeners:

1. Define listeners in the config/plugin.php

'webhooks' => [
    'jira:issue_updated' => \App\Listeners\Webhooks\Issue\Created::class,

2. Define listeners using the Webhook facade, for example:

Webhook::listen('jira:issue_created', function(\AtlassianConnectCore\Models\Tenant $tenant, \Illuminate\Http\Request $request) {
    // ...

As you can see, you can define event listener as a closure or as a string in Laravel-like syntax:

Webhook::listen('jira:issue_created', \App\Listeners\Webhooks\Issue\Created::class);
Webhook::listen('jira:issue_created', 'App\Listeners\Webhooks\Issue\Created@handle');

You do not need to define the webhooks within your add-on descriptor, they will be described automatically.

Example listener


namespace App\Listeners\Webhooks\Issue;

use Illuminate\Http\Request;
use AtlassianConnectCore\Models\Tenant;

class Created
     * Create the event listener.
     * @return void
    public function __construct()

     * Handle the incoming webhook
     * @param \AtlassianConnectCore\Models\Tenant $tenant
     * @param \Illuminate\Http\Request $request
     * @return void
    public function handle(Tenant $tenant, Request $request)
        // ...

Your event listeners may also type-hint any dependencies they need on their constructors. All event listeners are resolved via the Laravel service container, so dependencies will be injected automatically.

The handling method have the following parameters:

  1. $tenant - Authenticated Tenant model instance.
  2. $request - Request instance with Webhooks payload.

Console commands

  • plugin:install is a helper command that creates "dummy" tenant with fake data and publishes package resources (config, views, assets)
  • plugin:dummy provides interactive way to set tenant as "dummy" without manually editing database


Run the following in the package folder:



  • Implement descriptor builder and validator
  • Implement webhooks manager
  • Take out pagination and make more abstract


If you discover any security related issues, please email instead of using the issue tracker.



The MIT License (MIT). Please see License File for more information.