Configure Jira Service Desk Templated Connection

You can configure a templated connection in the Alert Logic console to send notifications to Jira Service Desk. When you set up a notification and subscribe a templated connection, Alert Logic sends the event to the URL you configured and generates a service desk request in Jira Service Desk automatically.

Alert Logic notifications alert you to threats, changes, and scheduled events in your environment so you can respond quickly. From the Alert Logic console, you can subscribe your Jira Service Desk templated connection to receive:

• Incident notifications—Generate a service desk request when incidents occur that match specific criteria, such as escalated incidents.
• Log correlation notifications—Generate a service desk request when your log correlation rules trigger an incident or observation.
• Health Notifications—Generate a service desk request when health exposures are found that match specific criteria.
• Scheduled report notifications—Generate a service desk request when Alert Logic generates a scheduled report that is available for download.

Complete the following steps to successfully generate requests in Jira Service Desk:

1. Identify the connection
2. Identify your Jira Service Desk URL path
3. Customize the payload template
4. Create the Jira Service Desk templated connection from the Alert Logic console
5. Subscribe your templated connection to receive notifications

Identify the connection

This templated connection requires a Jira Service Desk connection, which stores authentication and credential information that grants Alert Logic access to Jira Service Desk. If you do not have the connection already, you can create it now or when you create the templated connection.

For more information, see Configure Jira Service Desk Connection.

Identify your Jira Service Desk URL path

The Alert Logic console provides the default URL path that Jira Service Desk requires for ticket creation. The URL path is added to the base URL in the connection to define the full URL. Advanced API integration targeting can be done by modifying the URL path.

Customize the payload template

Decide which type of security information that you want Alert Logic to send to Jira Service Desk: Incident, Observation (of a log correlation), Scheduled Report Notification, or Health Notification payload.

Alert Logic provides a template for each payload type in JSON format using Mustache template-like transformations where a field in the JSON payload can be referenced by enclosing it in braces ({{}}. For example, the threatRating field in the following JSON {'incident': {'threat.Rating': "critical"}} is specified as {{incident.threatRating}}. A payload template converts the Alert Logic security information to the format expected by Jira Service Desk. You can add or remove lines in the sample template to meet your workflow requirements and security goals. You must replace placeholder information in angle brackets with valid values.

For definitions of the Alert Logic variables in the templates and the full JSON that you can use to configure your payload template in JQ or JSON format, see:

• Incident Schema
• Correlation Rule Observation Schema
• Scheduled Report Notification Schema
• Health Schema

Incident payload template

1
2
3
4
5
6
7
8
{
  "serviceDeskId": "<SERVICE DESK ID>",
  "requestTypeId": "<REQUEST TYPE ID>",
  "requestFieldValues": {
    "summary": "{{ incident.summary }}",
    "description": "{{ incident.description }}"
  }
}

Observation payload template

1
2
3
4
5
6
7
8
{
  "serviceDeskId": "<SERVICE DESK ID>",
  "requestTypeId": "<REQUEST TYPE ID>",
  "requestFieldValues": {
    "summary": "{{ fields.summary }}",
    "description": "{{ fields.desc }}"
  }
}

Scheduled Report Notification payload template

1
2
3
4
5
6
7
8
{
  "serviceDeskId": "<SERVICE DESK ID>",
  "requestTypeId": "<REQUEST TYPE ID>",
  "requestFieldValues": {
    "summary": "{{ name }}",
    "description": "Alert Logic scheduled report {{artifact_data.metadata.report_type}} has completed. View Report: {{extra.ui_url}}"
  }
}

Health Notification payload template

1
2
3
4
5
6
7
8
{
  "serviceDeskId": "<SERVICE DESK ID>",
  "requestTypeId": "<REQUEST TYPE ID>",
  "requestFieldValues": {
    "summary": "Remediation ID {{remediation_id}} | {{report_description}}",
    "description": "Alert Logic detected an exposure in Alert Logic customer account {{customer_account_name}} (ID: {{cid}}): {{report_description}} Exposure Impact: {{exposure_impact}}, Resolution: {{resolution}}, Deployment: {{deployment_name}}, Target Asset Type: {{target_asset_type}}"
  }
}

Create the Jira Service Desk templated connection from the Alert Logic console

The next step is to create the templated connection in the Alert Logic console and test the payload.

To create a Jira Service Desk templated connection:

1. In the Alert Logic console, click the navigation menu icon (), click Configure, and then click Connections.
2. Click the Templated Connections tab.
3. On the Templated Connections page, click the add icon (), and then click Jira Service Desk.
4. On the Create a Jira Service Desk Templated Connection page, type a descriptive name for the templated connection—for example, "Jira Service Desk Templated Connection for Incidents."
5. In Connection, select or create a Jira Service Desk connection.
6. In URL Path, leave the information as is. The field is prepopulated with the URL path that Jira Service Desk requires.
7. (Optional) In Additional Header(s), enter any custom HTTP request headers your integration requires, in addition to the ones defined in the Jira Service Desk connection, as HTTP header name-value pairs. Each header must be on a separate line.
8. Select the Payload Type, which is the type of Alert Logic security information that you want to send: Incident, Observation (of a log correlation), Scheduled Report Notification, or Health Notification.
9. Select the format of the payload template you customized earlier: JSON or JQ.
10. Select an HTTP verb for the templated connection payload. If you are unsure, leave it as the default verb: POST.
11. In the Payload Template area, enter the payload template that you customized.
A red bar next to a line indicates a syntax error. Code with errors is underlined with a jagged red line. You can hover your pointer over the underlined code to view a tip about the error.
12. Click TEST to send a test event to the URL provided. For more information about test results, see the next section.
13. If your templated connection sent the test event to the URL successfully, click SAVE.

Test results

If you receive a message that the templated connection was successfully tested, Alert Logic sent the payload template you configured and populated a service desk request in Jira Service Desk with sample data. Check Jira Service Desk to ensure the results are expected, and adjust the payload template if necessary.

If the test is unsuccessful, Alert Logic displays an error message. For server response errors, you can use the error code and message that Alert Logic passes through to troubleshoot the issue. Alert Logic also informs you if your JSON or JQ payload template contains syntax errors.

Subscribe your templated connection to receive notifications

After you test and save the templated connection configuration, the last step is to set up your notification criteria and subscribe the templated connection.

You can set up and manage a notification of any type directly from the Notifications page. For more information, see Manage Notifications. You can create notifications from other pages according to notification type:

• For incidents, you can also create a notification from the Incidents page. For more information, see Incident Notifications.
• For observations, you can also create a notification from the Search page (Log Search tab or Correlations tab) during the process of creating the correlation or by editing an existing correlation listed on the Correlations tab. For more information, see Correlations and Notifications and Observation Notifications.
• For health exposures, you can also create a notification from the Health page. For more information, see Health Notifications.
• For scheduled reports, you can also schedule the report and subscribe notification recipients from the Reports page. For more information, see Scheduled Reports and Notifications.

Manage your templated connections

You can view the list of templated connections and edit or delete an existing one. For more information, see Manage Templated Connections.