Integrate with Amazon SNS

This article highlights a new alerting feature that's natively available in Jira Service Management which is gradually rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

Amazon SNS makes it simple and cost-effective to push notifications to Apple, Google, Fire OS, and Windows devices, as well as Android devices in China with Baidu Cloud Push.

What does the integration offer?

Jira Service Management acts as a dispatcher for Amazon SNS notifications, determines the right people to notify based on on-call schedules– notifies via them using email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

When an alert is created in SNS, an alert is created in Jira Service Management automatically through the integration.

Set up the integration

Amazon SNS is an API-based integration. Setting it up involves the following steps:

Add an Amazon SNS integration in Jira Service Management
Set up a subscription in Amazon SNS

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add an Amazon SNS integration in Jira Service Management, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Amazon SNS”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the integration URL, which includes Jira Service Management’s endpoint and the API key.
You will use this URL while configuring the integration in Amazon SNS later.
Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.

Set up a subscription in Amazon SNS

To set up a subscription in Amazon SNS, complete the following steps:

Create an SNS topic. Find out how to get started with Amazon SNS.
Add an HTTPS subscription to your topic with the URL you copied while adding the integration in Jira Service Management as the endpoint. If the configuration is successful, a confirmation alert is created in Jira Service Management. Find out how to add an HTTPS subscription.
Specify the alert's alias, entity, tags, recipients, teams, and custom actions using message attributes. Read more about Amazon SNS message attributes.

SNS message attributes

AmazonSNSClient snsClient = new AmazonSNSClient(new BasicAWSCredentials("AWS_ACCESS_KEY","AWS_SECRET_KEY"));

String msg = "This is the description of Sns Integration test alert";
String subject = "Sns Integration Test alert";
PublishRequest publishRequest = new PublishRequest("arn:aws:sns:us-east-1:974xxxxxxx:JsmSns", msg, subject);publishRequest.addMessageAttributesEntry("eventType", new MessageAttributeValue()
                    .withDataType("String").withStringValue("create"));
publishRequest.addMessageAttributesEntry("alias", new MessageAttributeValue()
                    .withDataType("String").withStringValue("testalertalias"));
publishRequest.addMessageAttributesEntry("entity", new MessageAttributeValue()
                    .withDataType("String").withStringValue("Test alert entity"));
publishRequest.addMessageAttributesEntry("tags", new MessageAttributeValue()
                    .withDataType("String").withStringValue("trial"));
publishRequest.addMessageAttributesEntry("recipients", new MessageAttributeValue()
                    .withDataType("String").withStringValue("none"));
publishRequest.addMessageAttributesEntry("teams", new MessageAttributeValue()
                    .withDataType("String").withStringValue("team1,team2"));
publishRequest.addMessageAttributesEntry("actions", new MessageAttributeValue()
                    .withDataType("String").withStringValue("customAction"));

PublishResult publishResult = snsClient.publish(publishRequest);

All the fields in "MessageAttributes" are optional. To specify the action to run, send the "eventType" field. An alert is created if "eventType" is not specified. To run actions, specify "eventType" as follows:

create action > "eventType" : {"Type":"String","Value":"create"}
close action > "eventType" : {"Type":"String","Value":"close"}
acknowledge action > "eventType" : {"Type":"String","Value":"acknowledge"}
add note action > "eventType" : {"Type":"String","Value":"addNote"}

Sample payload sent from Amazon SNS

Create alert payload (in JSON format)

{
  "Type" : "Notification",
  "MessageId" : "0323d595-6aed-5dd4-a378-9811daf7d3ed",
  "TopicArn" : "arn:aws:sns:us-east-1:9747xxxxxxx:gj",
  "Subject" : "Sns Integration Test alert",
  "Message" : "This is the description of Sns Integration test alert",
  "Timestamp" : "2015-03-18T15:24:31.877Z",
  "SignatureVersion" : "1",
  "Signature" : "QplK4lyJWAtjIV9BzcF4AHTKT+VTupYqJIzxxxxxxxxxxx4QR8EdAYr31xDjI8...",
  "SigningCertURL" : "https://sns.us-east-1.amazonaws.com/SimpleNotificationService-dxxxxd67.pem",
  "UnsubscribeURL" : "https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe..",
  "MessageAttributes" : {
    "alias" : {"Type":"String","Value":"testalertalias"},
    "entity" : {"Type":"String","Value":"snstestentity"},
    "tags" : {"Type":"String","Value":"tag1,tag2"},
    "eventType" : {"Type":"String","Value":"create"},
    "recipients" : {"Type":"String","Value":"all"},
    "teams" : {"Type":"String","Value":"team1,team2"},
    "actions" : {"Type":"String","Value":"act1,act2"}
  }
}

Was this helpful?

It wasn't accurate

It wasn't clear

It wasn't relevant

Still need help?

The Atlassian Community is here for you.

Ask the Community