Configuring email notifications to notify Jira users

You can configure Connector for Salesforce & Jira to send email notifications when an event is triggered.

The set up consists of two parts:

  1. Specifying Jira groups to notify, in Jira.
  2. Creating and deploying required Apex triggers, in Salesforce.

At the moment, the Connector supports sending email notifications to Jira users when someone creates a Case comment.

Specifying Jira Groups to notify

Jira groups can be specified at the Connection level. This affects each binding and Jira project that is using the Connection.

  1. If you are using Jira Cloud, click the Jira icon in the top left (, or ) > Salesforce > Connections.
    If you are using Jira Server, click  > Add-ons, and then in the sidebar go to Salesforce > Connections.

  2. At the Salesforce Connections screen, go to the Connection you want to configure > Configure.

  3. Under Notification Settings, choose who you want to send notifications to by selecting All recipients of Issue Commented eventCurrent Assignee, Reporter, All Watchers, All Voters and/or Groups.
    For more information about All recipients of Issue Commented event, see "Sending Notifications Based on a Project's Notification Scheme".



  4. Click Save.

Sending notifications based on a Project's notification scheme

The All recipients of Issue Commented event setting allows you to enable email notifications that are defined within your Jira's Notification Scheme.

The event that is triggered is the Issue Commented event and is dependent on the Notification Scheme that is set up for the project that the Connection is bound to.

Do take note that only the following recipients are supported: 

  • Current Assignee
  • Reporter
  • Single User 
  • Group
  • All Watchers

Creating and deploying Apex triggers

The Connector relies on Apex triggers to be informed of changes on Salesforce objects. These triggers have to be created and deployed manually in Salesforce.

For Salesforce Enterprise and Unlimited editions, the standard deployment of Apex triggers are required (see Salesforce documentation).

Notifying Jira of new comments on Cases

This provides notifications when someone creates a comment in Salesforce.

Note that the email notification will be sent:

  • Based on the  Comment Privacy and Comment Tag Filter settings in the Connection configuration page.
  • Only to Jira issues currently associated with the Case.
  • Only to Jira users (in the specified groups) who have access to the associated Jira issue.

A successful email notification may look like this:

Adding CaseComment trigger 

The JCFS.API.fireEvents() API endpoint allows Jira to be notified of events happening in Salesforce, typically originating from Salesforce triggers.

Call JCFS.API.fireEvents() in an after insert Trigger on CaseComment as follows:

Notify JIRA of new comments on Cases
trigger CaseCommentsCreated on CaseComment (after insert) {
	JCFS.API.fireEvents(JCFS.Events.fromCreatedCaseComments(Trigger.new));
}

If you don't wish to send all triggered CaseComment objects to Jira, you can simply pass a filtered List<CaseComment> to JCFS.Events.fromCaseComments() .

Testing CaseComment trigger

To get test coverage for CaseComment trigger use the provided test helper as shown:

Apex test class for CaseComment trigger
@isTest public class CaseCommentCreatedTriggerTest {
	@isTest static void caseCommentAfterInsertTest() {
		Case randomCase = new Case(Subject = 'CaseCommentCreatedTriggerTest');
		insert randomCase;
		CaseComment randomCaseComment = new CaseComment(
			ParentId = randomCase.Id,
			CommentBody = 'In faucibus orci est, vitae dignissim enim commodo a.'
		);
		JCFS.JiraTriggerTestHelper.testAfterInsert(randomCaseComment);
	}
}

Advanced information

If you have other triggers with Webservice callouts that are executed as a result of running this test, you might get an error message like this:

Method defined as TestMethod do not support Web service callouts

In order to fix this error, you need to specify a fake response for the callouts. JiraTriggerTestHelper already provides a mock for its test method, but it will not mock other webservice callouts. Therefore, you may need to provide your own implementation of HttpCalloutMock.

Please customize the following code according to your callout method:

SuccessCalloutMock
public class SuccessCalloutMock implements HttpCalloutMock {
    public HTTPResponse respond(HTTPRequest req) {
        HttpResponse response = new HttpResponse();
        response.setStatusCode(200);
        return response;
    }
}

Then, set the mock before the CaseCommentCreatedTriggerTest test method is called.

CaseCommentCreatedTriggerTest
@isTest public class CaseCommentCreatedTriggerTest {
    @isTest static void caseAfterInsertTest() {
        Test.setMock(HttpCalloutMock.class, new SuccessCalloutMock());
        Case randomCase = new Case(Subject = 'CaseCommentCreatedTriggerTest');
		insert randomCase;
		CaseComment randomCaseComment = new CaseComment(
			ParentId = randomCase.Id,
			CommentBody = 'In faucibus orci est, vitae dignissim enim commodo a.'
		);
        Test.startTest();
        insert randomCaseComment;
        Test.stopTest();
    }
}

For more details, please refer to the Salesforce documentation.