Connect Intergration Patterns: A Case Study - Patrick Streule
1 like1,161 views
The document provides an overview of Connect integration patterns at Atlassian, including how add-ons can integrate with Connect applications using authentication methods like JWT. It discusses the development process from creating a descriptor and add-on service locally to deploying to staging and production. Examples are given of how add-ons can be installed across multiple applications and handle events through webhooks.
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-6-320.jpg)
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}
Add-on service
location](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-7-320.jpg)
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}
How to auth
calls
Add-on service
location](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-8-320.jpg)
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}
How to auth
calls
Lifecycle
notification
endpoints
Add-on service
location](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-9-320.jpg)
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}
Where is the
add-on
showing up?
How to auth
calls
Lifecycle
notification
endpoints
Add-on service
location](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-10-320.jpg)
![CONNECT REFRESHER
Simple Descriptor
{
"key": "my-add-on",
"name": "Ping Pong",
"description": "My very first add-on",
"baseUrl": "{{localBaseUrl}}",
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed"
},
"modules": {
"generalPages": [{
"key": "hello-world-page-jira",
"location": "system.top.navigation.bar",
"name": {
"value": "Hello World"
},
"url": "/hello-world"
}]
}
}
Where is the
add-on
showing up?
iFrame URL
How to auth
calls
Lifecycle
notification
endpoints
Add-on service
location](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-11-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
"event": "*",
"url": "/events"
}
]](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-34-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
"event": "*",
"url": "/events"
}
]](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-35-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
"event": "*",
"url": "/events"
}
]
/events](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-36-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
/events
JWT
"event": "*",
"url": "/events"
}
]](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-37-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
/events
JWT
"event": "*",
"url": "/events"
}
]](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-38-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
1
2
/events
JWT Group
bb-addon.json
hc-addon.json
"webhooks": [
{
"event": "*",
"url": "/events"
}
]](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-39-320.jpg)
![Authentication: Multiple Service Accounts
Add-On
1
2
/events
JWT Group Auth
1
2
bb-addon.json
hc-addon.json
"webhooks": [
{
"event": "*",
"url": "/events"
}
]
Token
2](https://image.slidesharecdn.com/connectintegrationpatterns-acasestudy-patrickstreule-140929164003-phpapp01/85/Connect-Intergration-Patterns-A-Case-Study-Patrick-Streule-40-320.jpg)
Connect Intergration Patterns: A Case Study - Patrick Streule
- 1. #atlassian
- 2. Connect Integration Patterns A Case Study PATRICK STREULE • CONNECT ARCHITECT • ATLASSIAN • @PSTREULE
- 4. CONNECT REFRESHER Atlassian Plug-ins Add-On • In Process • Resources are shared • Access to all data • Tied to the stack • Language • Frameworks Add-On
- 5. CONNECT REFRESHER Connect Add-Ons Add-On • Separate Process • Scales independently • Data access only through REST API • Choose your own stack • Language • Frameworks Add-On Connect HTTPS
- 6. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } }
- 7. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } } Add-on service location
- 8. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } } How to auth calls Add-on service location
- 9. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } } How to auth calls Lifecycle notification endpoints Add-on service location
- 10. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } } Where is the add-on showing up? How to auth calls Lifecycle notification endpoints Add-on service location
- 11. CONNECT REFRESHER Simple Descriptor { "key": "my-add-on", "name": "Ping Pong", "description": "My very first add-on", "baseUrl": "{{localBaseUrl}}", "authentication": { "type": "jwt" }, "lifecycle": { "installed": "/installed" }, "modules": { "generalPages": [{ "key": "hello-world-page-jira", "location": "system.top.navigation.bar", "name": { "value": "Hello World" }, "url": "/hello-world" }] } } Where is the add-on showing up? iFrame URL How to auth calls Lifecycle notification endpoints Add-on service location
- 12. CONNECT REFRESHER Product WEBHOOKS REST API REST API HTTP Add-On
- 13. From Add-Ons to Integrations
- 15. Integration Add-Ons Add-On Connect Application
- 16. Integration Add-Ons Add-On Connect Application Add-On Application
- 17. Authentication
- 18. Authentication Add-On Connect Application JWT
- 19. Authentication Add-On Connect Application JWT
- 20. Authentication: Service Account Add-On Application JWT API Key Auth Token Basic Auth
- 21. Example: Bitbucket Notifications in HipChat
- 22. Example: Bitbucket Notifications in HipChat
- 23. Example: Bitbucket Notifications in HipChat
- 24. Example: Bitbucket Notifications in HipChat
- 25. Example: Bitbucket Notifications in HipChat
- 26. Example: Bitbucket Notifications in HipChat
- 27. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json
- 28. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json "installable": { "callbackUrl": "/installed" }
- 29. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json 1 "installable": { "callbackUrl": "/installed" } 1 2 /installed 2
- 30. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json "configurePage": { "url": "/config" } 1 "installable": { "callbackUrl": "/installed" } 1 2 /installed 2
- 31. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json "configurePage": { "url": "/config" } "installable": { "callbackUrl": "/installed" } /config 1 1 2 /installed 2
- 32. Installed in Bitbucket and HipChat Add-On bb-addon.json hc-addon.json "configurePage": { "url": "/config" } "installable": { "callbackUrl": "/installed" } /config 1 1 2 /installed 2
- 33. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json
- 34. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json "webhooks": [ { "event": "*", "url": "/events" } ]
- 35. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json "webhooks": [ { "event": "*", "url": "/events" } ]
- 36. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json "webhooks": [ { "event": "*", "url": "/events" } ] /events
- 37. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json "webhooks": [ { /events JWT "event": "*", "url": "/events" } ]
- 38. Authentication: Multiple Service Accounts Add-On 1 2 1 2 bb-addon.json hc-addon.json "webhooks": [ { /events JWT "event": "*", "url": "/events" } ]
- 39. Authentication: Multiple Service Accounts Add-On 1 2 1 2 /events JWT Group bb-addon.json hc-addon.json "webhooks": [ { "event": "*", "url": "/events" } ]
- 40. Authentication: Multiple Service Accounts Add-On 1 2 /events JWT Group Auth 1 2 bb-addon.json hc-addon.json "webhooks": [ { "event": "*", "url": "/events" } ] Token 2
- 41. Authentication: Mapped User Accounts (3LA) Add-On Application JWT AghJ87s l9JUYfsg ?
- 42. Authentication: Mapped User Accounts (3LA) Add-On Application JWT AghJ87s l9JUYfsg ?
- 43. Authentication: Mapped User Accounts (3LA) Add-On Application JWT AghJ87s l9JUYfsg ?
- 44. Authentication: Mapped User Accounts (3LA) Add-On Application JWT NPcudk7 AghJ87s l9JUYfsg
- 45. Authentication: Mapped User Accounts (3LA) Add-On Application JWT NPcudk7 AghJ87s l9JUYfsg Auth Token NPcudk7
- 47. Get Started Dev Loop LOCAL • Learn: https://connect.atlassian.com • Create your JSON descriptor • Create your add-on service • Host and test locally STAGING • Create private Marketplace listing • Deploy add-on to a staging environment • Test add-on on a Cloud JIRA or Confluence instance PRODUCTION • Deploy add-on to a production environment
- 48. Private listing • Not visible for others • Version management • Tokens to control allowed installs
- 49. Thank you! PATRICK STREULE • CONNECT ARCHITECT • ATLASSIAN • @PSTREULE