This document discusses using triggers to automate actions in Forge apps. It begins with an overview of triggers and then discusses: - Product triggers that are triggered by events in Atlassian products like Jira, Confluence etc. - Web triggers that are triggered by HTTP requests to a Forge function. - How to authenticate and make requests to external services like Opsgenie from Forge functions in response to triggers. - Demos of building a Forge app that responds to Jira issue creation by assigning the issue and notifying Opsgenie. The document provides details on the event payload formats, making authenticated requests, and deploying/managing the Forge app lif

1. Take action with
triggers
TOMEK SROKA | SOFTWARE DEVELOPER | ATLASSIAN

2. AUTOMATION

3. Deployment &
Observability
Authentication &
Authorization
Infrastructure
Connect & 3LO apps

4. Forge UI
Forge
Developer ExperienceAtlassian Hosting

5. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

6. Platform Services
Stargate
api.atlassian.com, 3LO, rate limiting
Streamhub
Distributed event bus

9. ALERT IN OPSGENIE
Acknowledge
On-call must acknowledge within
15 minutes or alert will be escalate

10. IT SUPPORT

11. IT SUPPORT

12. IT Support

13. APP FEATURES
• Tickets should be automatically assigned to a person
currently on-call.
• If the ticket is about a problem with a service and
severity is critical, then a person on-call should be
alerted.
• When an on-call person acknowledges an alert, ticket
should be commented

14. ASSIGNING ISSUE

15. Getting started with Forge

16. Node.js 12+ NPM
Prerequisites

17. $ npm install -g @atlassian/forge-cli
$ forge login
$ forge create

18. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

19. Forge
Application
Manifest
Functions
Lifecycle
app:
id: ari:cloud:ecosystem::app/1234
name: forge-example-app
description: forge example app
modules:
function:
- key: example-function
handler: index.run
trigger:
- key: jira-event-created
function: example-function
events:
- created:issue

20. Forge
Application
Manifest
Functions
Lifecycle
export async function run(event, context) {
console.log(`Hello from example App!`);
return {
"message": "hello world"
};
}
index.js:
modules:
function:
- key: example-function
handler: index.run
manifest.yml:

21. Forge
Application
Manifest
Functions
Lifecycle
Functions can be written in anything
that compiles to JavaScript
Executed in constrained
environment
Runtime provides some basic
building blocks

22. Forge
Application
Manifest
Functions
Lifecycle
dev-1.atlassian.net
dev-2.atlassian.net
my-company.atlassian.net
$ forge install

23. Forge
Application
Manifest
Functions
Lifecycle
Development Staging Production
Ver 5 Ver 4 Ver 3 stable
pre-prod.atlassian.net
dev-1.atlassian.net
dev-2.atlassian.net
my-company.atlassian.net

24. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

25. Product triggers
Created issue
Modified issue
Transitioned issue
…
Created paged
Modified page
Commented page
…
Event bus
TRIGGER SERVICE

26. Event types
CREATED:ISSUE
ASSIGNED:ISSUE
DELETED:ISSUE UPDATED:ISSUE
TRANSITIONED:ISSUE
VIEWED:ISSUE
UNASSIGNED:ISSUE
COMMENTED:COMMENT
VIEWED:PAGE
TRANSITIONED:TASK
PUBLISHED:PAGE
UNASSIGNED:TASK
COMMENTED:COMMENT
LIKED:PAGE
DELETED:TASK
ASSIGNED:TASK
DELETED:PAGEEDITED:PAGE

27. {
"accountId": "501011:5ba7990e-ae0f-40de-afcc-a92ed2aca3e2",
"activityItem": {
"timestamp": "2019-08-27T09:22:21.303Z",
"eventType": "CREATED",
"object": {
"localResourceId": "120342",
"name": "AUT-1 Onboarding request",
"type": "ISSUE",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/browse/AUT-1",
"iconURL": "https://atlassian.net/secure/viewavatar?avatarId=10310"
Event Format

28. {
"accountId": "501011:5ba7990e-ae0f-40de-afcc-a92ed2aca3e2",
"activityItem": {
"timestamp": "2019-08-27T09:22:21.303Z",
"eventType": "CREATED",
"object": {
"localResourceId": "120342",
"name": "AUT-1 Onboarding request",
"type": "ISSUE",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/browse/AUT-1",
"iconURL": "https://atlassian.net/secure/viewavatar?avatarId=10310"
Event Format

29. {
"accountId": "501011:5ba7990e-ae0f-40de-afcc-a92ed2aca3e2",
"activityItem": {
"timestamp": "2019-08-27T09:22:21.303Z",
"eventType": "CREATED",
"object": {
"localResourceId": "120342",
"name": "AUT-1 Onboarding request",
"type": "ISSUE",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/browse/AUT-1",
"iconURL": "https://atlassian.net/secure/viewavatar?avatarId=10310"
},
"containers": [
{
Event Format

30. "product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/browse/AUT-1",
"iconURL": "https://atlassian.net/secure/viewavatar?avatarId=10310"
},
"containers": [
{
"localResourceId": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"type": "SITE",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net"
},
{
"localResourceId": "13011",
"name": "Automation Test Project",
Event Format

31. "type": "SITE",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net"
},
{
"localResourceId": "13011",
"name": "Automation Test Project",
"type": "PROJECT",
"product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/projects/AUT"
}
],
"contributors": [
{
Event Format

32. "product": "JIRA_SERVICE_DESK",
"cloudID": "158c8204-ff3b-47c2-adbb-a0906c00ffee",
"url": "https://product-fabric.atlassian.net/projects/AUT"
}
],
"contributors": [
{
"profile": {
"accountId": "501011:5ba7990e-ae0f-40de-afcc-a92ed2aca3e2"
},
"lastAccessedDate": "2019-08-27T09:22:21.303Z",
"count": 1
}
]
}
}
Event Format

33. Opsgenie - making a request
// Use environment variables to get API TOKEN, never hardcode such
things.
const scheduleId = getEnvVariable("OPSGENIE_SCHEDULE_ID");
const opsGenieApiKey = getEnvVariable("OPSGENIE_API_KEY");
console.log(`Looking for on-call person for schedule ${scheduleId}
`);
const onCallEmail = await fetchOnCall(scheduleId, opsGenieApiKey);
console.log(`Determined on-call person email to be ${onCallEmail}`);
// If we did not get an email from opsgenie then too bad; What can
we do?
if (onCallEmail === null) {
return {};
}

34. async function fetchOnCall(scheduleId: string, apiKey: string) {
const url = `https://api.opsgenie.com/v2/schedules/${scheduleId}/
on-calls?flat=true`;
let response = await api.fetch(url, {
method: "GET",
headers: {
"Authorization": `GenieKey ${apiKey}`
}
});
if (!response.ok) {
throw `Cannot get opsgenie schedule. Status: $
{response.status}, ${response.statusText}`;
}
const responseBody = await response.json();
[…]
}
Opsgenie - making a request

35. Jira - making a request
export async function assignJiraIssue(issueId: string, userId: string) {
const url = `/rest/api/3/issue/${issueId}/assignee`;
const body = {
"accountId": userId
};
let response = await api
.asApp()
.requestJira(url, {
method: "PUT",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify(body)
});
[…]
}

36. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

37. Web triggers
+ OTHERS
https://app.hello.atlassian-dev.net/x0/eyJjd
TRIGGER SERVICE

38. Request
{
"method": "POST",
"headers": {
"content-type": [
"application/json"
]
},
"body": “{"id":"123"}",
"path": "/x0/eyJjdHg"
}

39. Response
{
"headers": {
"Content-Type": [
"text/plain"
]
},
"statusCode": 200,
"body": "Hello from web trigger"
}

40. Example function
export async function run(request) {
return {
headers: {
"Content-Type": ["text/plain"]
},
statusCode: 200,
body: `Hello from web trigger.n ${request.body}`
}
}

41. Manifest
modules:
function:
- key: func-pr-created
handler: index.onNewPr
webtrigger:
- key: github-pr-created
function: func-pr-created

42. Generating URL

43. Opsgenie - webhook

44. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

45. Triggering self
Commented:issue Event bus
POST /issue/comment
TRIGGER SERVICE

46. Out of order
processing
DuplicatesDelays
Working with Product Triggers
3 1 2

47. AUTHENTICATING
WEB TRIGGERS

48. Agenda
A case for automation
Anatomy of a Forge App
Under the covers
Demo
Product triggers
Web triggers

50. Thank you!
TOMEK SROKA | SOFTWARE DEVELOPER | ATLASSIAN

51. Q & A