Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

PagerDuty connects to your monitoring systems so that you can collect events, surface what's important, and resolve critical issues to proactively manage your uptime.

This document provides information about the PagerDuty connector, which facilitates automated interactions, with an PagerDuty server using FortiSOAR™ playbooks. Add the PagerDuty connector as a step in FortiSOAR™ playbooks and perform automated operations, such as listing teams, users, and notifications configured in PagerDuty and retrieving user details and notification rules from PagerDuty.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

  • You must have the URL of PagerDuty server to which you will connect and perform the automated operations and the API Key to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the PagerDuty connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL of the PagerDuty server to which you will connect and perform the automated operations.
API Key API key that is configured for your account to access the PagerDuty server.

 

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get User Details Retrieves details for an existing user from your PagerDuty account based on the user ID you have specified. get_user_info
Investigation
Get User Notification Rules Retrieves details for an existing user's notification rule from your PagerDuty account based on the user ID and notification rule ID you have specified. get_notification
Investigation
List Notifications Retrieves a list of notifications configured in your PagerDuty account based on the notification type and date range you have specified. get_notification
Investigation
List Teams Retrieves a list of all teams configured in your PagerDuty account. search_team
Investigation
List Users Retrieves a list of all users configured in your PagerDuty account. get_users
Investigation
Create Incident Creates an incident in your PagerDuty account based on the input parameters you have specified. create_incident
Investigation

 

operation: Get User Details

Input parameters

 

Parameter Description
User ID ID of the user whose details you want to retrieve from your PagerDuty account.

 

Output

The JSON output contains details of the specified user such as ID, notification rules, and email address, retrieved from your PagerDuty account, based on the user ID you have specified.

Following image displays a sample output:

 

Sample output of the Get User Details operation

 

operation: Get User Notification Rules

Input parameters

 

Parameter Description
User ID ID of the user whose notification rules you want to retrieve from your PagerDuty account.
Notification Rule ID ID of the notification rules for which you want to retrieve details from your PagerDuty account.

 

Output

The JSON output contains details of the specified notification rule such as notification rule name and contact methods, retrieved from your PagerDuty account, based on the user ID and notification rule ID you have specified.

Following image displays a sample output:

 

Sample output of the Get User Notification Rules operation

 

operation: List Notifications

Input parameters

 

Parameter Description
Notification Type Type of notification for which you want to retrieve details from your PagerDuty account.
You can choose from the following options: SMS Notification, Email Notification, Phone Notification, or Push Notification.
Since Start date and time from when you want to retrieve information about the specified notification type from your PagerDuty account.
Until End date and time till when you want to retrieve information about the specified notification type from your PagerDuty account.

 

Output

The JSON output contains details of the specified notification type such as the address to which the notification is sent and summary of the notification, retrieved from your PagerDuty account, based on the notification type and date range you have specified.

Following image displays a sample output:

 

Sample output of the List Notifications operation

 

operation: List Teams

Input parameters

None.

Output

The JSON output contains details such as ID, name, and type, retrieved from the PagerDuty server, of all the teams configured in your PagerDuty account.

Following image displays a sample output:

 

Sample output of the List Teams operation

 

operation: List Users

Input parameters

None.

Output

The JSON output contains details such as ID, summary, and job title, retrieved from the PagerDuty server, of all the users, configured in your PagerDuty account.

Following image displays a sample output:

 

Sample output of the List Users operation

 

operation: Create Incident

Input parameters

 

Parameter Description
From Email address of the user who is creating the incident in PagerDuty.
Integration Key Integration key (service key) that is used to access the PagerDuty API.
Title Title of the incident to be created in PagerDuty.
Description Description of the incident to be created in PagerDuty.
Service Name of the service under which the incident is to be created in PagerDuty.
Priority Priority of the incident to be created in PagerDuty.
Escalation Policy Name of the Escalation Policy with which the incident needs to be bound in PagerDuty.

 

Output

The JSON output contains details, such as ID, name, priority, and impacted service, of the incident created in your PagerDuty account, based on the input parameters you have specified.

Following image displays a sample output:

 

Sample output of the Create Incident operation

 

Included playbooks

The Sample - PagerDuty - 1.0.0 playbook collection comes bundled with the PagerDuty connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the PagerDuty connector.

  • Create Incident
  • Get User Details
  • Get User Notification Rules
  • List Notifications
  • List Teams
  • List Users

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

PagerDuty connects to your monitoring systems so that you can collect events, surface what's important, and resolve critical issues to proactively manage your uptime.

This document provides information about the PagerDuty connector, which facilitates automated interactions, with an PagerDuty server using FortiSOAR™ playbooks. Add the PagerDuty connector as a step in FortiSOAR™ playbooks and perform automated operations, such as listing teams, users, and notifications configured in PagerDuty and retrieving user details and notification rules from PagerDuty.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

 

Configuring the connector

For the procedure to configure a connector, click here.

 

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the PagerDuty connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL of the PagerDuty server to which you will connect and perform the automated operations.
API Key API key that is configured for your account to access the PagerDuty server.

 

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get User Details Retrieves details for an existing user from your PagerDuty account based on the user ID you have specified. get_user_info
Investigation
Get User Notification Rules Retrieves details for an existing user's notification rule from your PagerDuty account based on the user ID and notification rule ID you have specified. get_notification
Investigation
List Notifications Retrieves a list of notifications configured in your PagerDuty account based on the notification type and date range you have specified. get_notification
Investigation
List Teams Retrieves a list of all teams configured in your PagerDuty account. search_team
Investigation
List Users Retrieves a list of all users configured in your PagerDuty account. get_users
Investigation
Create Incident Creates an incident in your PagerDuty account based on the input parameters you have specified. create_incident
Investigation

 

operation: Get User Details

Input parameters

 

Parameter Description
User ID ID of the user whose details you want to retrieve from your PagerDuty account.

 

Output

The JSON output contains details of the specified user such as ID, notification rules, and email address, retrieved from your PagerDuty account, based on the user ID you have specified.

Following image displays a sample output:

 

Sample output of the Get User Details operation

 

operation: Get User Notification Rules

Input parameters

 

Parameter Description
User ID ID of the user whose notification rules you want to retrieve from your PagerDuty account.
Notification Rule ID ID of the notification rules for which you want to retrieve details from your PagerDuty account.

 

Output

The JSON output contains details of the specified notification rule such as notification rule name and contact methods, retrieved from your PagerDuty account, based on the user ID and notification rule ID you have specified.

Following image displays a sample output:

 

Sample output of the Get User Notification Rules operation

 

operation: List Notifications

Input parameters

 

Parameter Description
Notification Type Type of notification for which you want to retrieve details from your PagerDuty account.
You can choose from the following options: SMS Notification, Email Notification, Phone Notification, or Push Notification.
Since Start date and time from when you want to retrieve information about the specified notification type from your PagerDuty account.
Until End date and time till when you want to retrieve information about the specified notification type from your PagerDuty account.

 

Output

The JSON output contains details of the specified notification type such as the address to which the notification is sent and summary of the notification, retrieved from your PagerDuty account, based on the notification type and date range you have specified.

Following image displays a sample output:

 

Sample output of the List Notifications operation

 

operation: List Teams

Input parameters

None.

Output

The JSON output contains details such as ID, name, and type, retrieved from the PagerDuty server, of all the teams configured in your PagerDuty account.

Following image displays a sample output:

 

Sample output of the List Teams operation

 

operation: List Users

Input parameters

None.

Output

The JSON output contains details such as ID, summary, and job title, retrieved from the PagerDuty server, of all the users, configured in your PagerDuty account.

Following image displays a sample output:

 

Sample output of the List Users operation

 

operation: Create Incident

Input parameters

 

Parameter Description
From Email address of the user who is creating the incident in PagerDuty.
Integration Key Integration key (service key) that is used to access the PagerDuty API.
Title Title of the incident to be created in PagerDuty.
Description Description of the incident to be created in PagerDuty.
Service Name of the service under which the incident is to be created in PagerDuty.
Priority Priority of the incident to be created in PagerDuty.
Escalation Policy Name of the Escalation Policy with which the incident needs to be bound in PagerDuty.

 

Output

The JSON output contains details, such as ID, name, priority, and impacted service, of the incident created in your PagerDuty account, based on the input parameters you have specified.

Following image displays a sample output:

 

Sample output of the Create Incident operation

 

Included playbooks

The Sample - PagerDuty - 1.0.0 playbook collection comes bundled with the PagerDuty connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the PagerDuty connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.