Configure PagerDuty Templated Connection

You can configure a templated connection in the Alert Logic console to send notifications to PagerDuty. When you set up a notification and subscribe a templated connection, Alert Logic sends the event to the URL you configured and creates a message in PagerDuty 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 PagerDuty templated connection to receive:

Complete the following steps to successfully send messages to PagerDuty:

  1. Identify the connection
  2. (Optional) Identify your PagerDuty URL path
  3. Customize the payload template
  4. Create the PagerDuty templated connection from the Alert Logic console
  5. Subscribe your templated connection to receive notifications

Identify the connection

This templated connection requires a PagerDuty connection, which stores authentication and credential information that grants Alert Logic access to PagerDuty. 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 PagerDuty Connection.

(Optional) Identify your PagerDuty URL path

The Alert Logic console provides the default URL path that PagerDuty requires. 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 PagerDuty: Incident, Observation (of a log correlation), Scheduled Report Notification, or Health Notification payload.

If you want to send more than one payload type, you must configure a templated connection for each one. Because the payload is different, each payload type requires a separate templated connection instance.

Alert Logic provides a template for each payload type using JQ transformation. A payload template converts the Alert Logic security information to the format expected by PagerDuty. You can add or remove lines in the sample template to meet your workflow requirements and security goals.

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:

For more information about JQ, see JQ. A helpful website for converting JSON to JQ is jq play.

Incident payload template

Copy

JQ Template

{
  "routing_key": "{{routing_key}}",
  "event_action": "trigger",
  "dedup_key":  .dedup_hint,
  "client": "Alert Logic",
  "client_url": "https://console.account.alertlogic.com/",
  "links": [
    {
      "href": .extra.incidentUrl,
      "text": "See Incident."
    }
  ],
  "payload": {
    "summary": .incident.summary,
    "severity": (if .incident_threat_rating == "Critical" then "critical" elif .incident_threat_rating == "High" then "critical" elif .incident_threat_rating == "Medium" then "warning" else "info" end),
    "group": "Security",
    "class": "security incident",
    "source": (.victim.value//.victim.ip),
    "timestamp": .createtime_str
  }
}

Observation payload template

Copy
JQ Template
{
    "routing_key": "{{routing_key}}",
    "event_action": "trigger",
    "dedup_key": .fields.id,
    "client": "Alert Logic",
    "client_url": "https://console.account.alertlogic.com/",
    "payload": {
        "summary": .fields.summary,
        "severity": (if .fields.severity == "critical" then "critical" elif   .fields.severity == "high" then "critical" elif .fields.severity == "medium" then "warning" else "info" end),
        "group": "Security",
        "class": "security observation",
        "source": .fields.path,
        "timestamp": .fields.ts | todate,
        "payload.custom_details": .fields.keys | fromjson
  }
}

Scheduled Report Notification payload template

Copy
JQ Template
{
  "routing_key": "{{routing_key}}",
  "event_action": "trigger",
  "client": "Alert Logic",
  "client_url": "https://console.account.alertlogic.com/",
  "payload": {
    "summary": ("Alert Logic Scheduled Report Complete: " + .artifact_data.metadata.report_description),
    "group": "Security",
    "class": "Scheduled Report",
    "source": "Alert Logic",
    "severity": "info",
    "timestamp": .artifact_data.create_time,
    "custom_details": ("Type: " + .artifact_data.metadata.report_type + " | Customer: " + .artifact_data.metadata.customer_name + " | Customer ID: " + .account_id + " | View Report: " + .extra.ui_url + " | Download Report: " + .extra.download_url)
  }
}

Health Notification payload template

Copy
JQ Template
{
  "routing_key": "{{routing_key}}",
  "event_action": "trigger",
  "dedup_key": .remediation_id,
  "client": "Alert Logic",
  "client_url": "https://console.account.alertlogic.com/",
  "payload": {
    "summary": .report_description,
    "group": "Security",
    "class": "Health Notification",
    "source": .deployment_name,
    "severity": "warning",
    "custom_details": ("Resolution: " + .resolution + " | Exposure Impact: " + .exposure_impact),
  }
}

Create the PagerDuty 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 PagerDuty 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 PagerDuty.
  4. On the Create a PagerDuty Templated Connection page, type a descriptive name for the templated connection—for example, "PagerDuty Templated Connection for Incidents."
  5. In Connection, select or create a PagerDuty connection.
  6. In URL Path, leave the information as is. The field is prepopulated with the URL path that PagerDuty requires.
  7. 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.
  8. Select the format of the payload template you customized earlier: JSON or JQ.
  9. Select an HTTP verb for the templated connection payload. If you are unsure, leave it as the default verb: POST.
  10. In the Payload Template area, enter the payload template that you customized.
    11. 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.
  11. Click TEST to send a test event to the URL provided. For more information, see Test results.
  12. 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 message in PagerDuty with sample data. Check PagerDuty 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.