PagerDuty

Cyware Orchestrate

PagerDuty

App Vendor: PagerDuty

App Category: IT Services

Connector Version: 2.1.0

API Version: 1.0.0

About App

Pagerduty is a cloud computing company that provides a SaaS incident response platform for IT departments.

PagerDuty app is configured with Orchestrate to perform the following actions:

Action Name	Description
Delete User	This action deletes a user.
Get Incident	This action retrieves the details of an incident.
Get on Call Entries	This action retrieves the on-call entries for a given time range.
Get Schedule	This action retrieves the details of a schedule.
Get Teams	This action retrieves all teams.
Get User	This action retrieves the details of a user.
Get Users on Call for Schedule	This action retrieves the users on-call for a schedule.
List Incidents	This action lists incidents.
List Schedules	This action retrieves the schedules.
List Users	This action lists the users of a PagerDuty account.
PagerDuty Delete Schedule	This action deletes a call schedule.
Send an Event	This action sends an event (alert) to Pagerduty.
Generic Action	This is a generic action used to make requests to any PagerDuty endpoint.

Configuration Parameters

The following configuration parameters are required for the PagerDuty app to communicate with the PagerDuty enterprise application. The parameters can be configured by creating instances in the app.

Parameter	Description	Field Type	Required/Optional	Comments
API Key	Enter the API key to connect to the Pagerduty instance.	Text	Required
Base URL	Enter the base URL to access PagerDuty. Example: https://api.pagerduty.com	Text	Optional	Default value: https://api.pagerduty.com
Timeout	Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with PagerDuty.	Integer	Optional	Allowed range: 15-120 Default value: 15
Verify	Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.	Boolean	Optional	By default, verification is enabled.

Action: Delete User

This action deletes a user.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
ID	Enter the user ID of a user that you need to delete. Example: "ps6anjz"	Text	Required

Parameter

Description

Field Type

Required/Optional

Comments

Enter the user ID of a user that you need to delete.

Example:

"ps6anjz"

Text

Required

Example Request

[
  {
    "id": "ps6anjz"
  }
]

Action: Get Incident

This action retrieves the details of an incident.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Incident ID	Enter an incident ID to retrieve the details of an incident. Example: Q01DZAJWQDPA7K	Text	Required
Include	Enter the array of additional details to include in the response.	List	Optional	Allowed values: acknowledgers, agents, assignees, conference_bridge, custom_fields, escalation_policies, first_trigger_log_entries, priorities, services, teams, users

Parameter

Description

Field Type

Required/Optional

Comments

Incident ID

Enter an incident ID to retrieve the details of an incident.

Example:

Q01DZAJWQDPA7K

Text

Required

Include

Enter the array of additional details to include in the response.

List

Optional

Allowed values:

acknowledgers, agents, assignees, conference_bridge, custom_fields, escalation_policies, first_trigger_log_entries, priorities, services, teams, users

Example Request

[
  {
    "include": [
      "acknowledgers",
      "assignee"
    ],
    "incident_id": "Q01DZAJWQDPA7K"
  }
]

Action: Get on Call Entries

This action retrieves the on-call entries for a given time range. An on-call is a contiguous unit of time for which a user is on call for an escalation policy and escalation rules.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Since	Enter the start time range to retrieve the on-call entries. The retrieved results are inclusive of the specified start time range. Example: "2015-03-06t15:28:51-05:00"	Text	Required	A search range cannot be more than 3 months.
Until	Enter the end time range to retrieve the on-call entries. The retrieved results are inclusive of the specified end time range. Example: "2015-03-06t15:28:51-05:00"	Text	Required	A search range cannot be more than 3 months. The value of until parameter cannot be before the since time.
Limit	Enter the maximum number of results to be displayed. Example: 80	Integer	Optional	Default value: 100
Offset	Enter the offset. Example: 10	Integer	Optional	Default value: 0
Earliest	Choose to return the earliest on-call for each combination of escalation policy, escalation level, and users. Example: false	Boolean	Optional	This parameter can be used to determine when the next on-calls are for a given set of filters. Allowed values: true false
Escalation Policy IDs	Enter the escalation policy IDs to display on-calls for the specified escalation policy IDs. Example: $LIST[fs6andz, bs6anjz]	List	Optional
Schedule IDs	Enter the schedule IDs to display on-calls for only the specified schedule IDs. Example: $LIST[as6anjz, ks5anjz]	List	Optional	If null is provided in the list array, it includes permanent on-calls due to direct user escalation targets.
User IDs	Enter the user IDs to display on-calls for only the specified user IDs. Example: $LIST[ps6antz, xs6anfz]	List	Optional
Query Params	Enter the query parameters to make the request.	Key value	Optional	Allowed keys: total, include, time_zone

Example Request

[
    {
        "since": "2022-06-06T15:28:51-05:00",
        "until": "2022-07-22T12:36:00-06:00"
        "limit": 80,
        "offset": 10, 
        "earliest": false,
        "esacalation_policy_ids: ["fs6andz", "bs6anjz"],
        "schedule_ids: ["as6anjz", "ks5anjz"],
        "user_ids": ["ps6antz", "xs6anfz"]
    }
]

Action: Get Schedule

This action retrieves the details of a schedule.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Schedule ID	Enter the schedule ID to retrieve details of a schedule. Example: P5YR9XT	Text	Required
Overflow	Choose true to include on-call schedule entries that extend beyond the date range.	Boolean	Optional	Default value: false
Since	Enter the start date range (in ISO 8601 format) over which you want to show schedule entries. Example: 2015-07-17T08:42:58.315+0000	Text	Optional	Defaults to 2 weeks before until if an until is given.
Time Zone	Enter the time zone to display the results.	Text	Optional	The default value is the schedule's time zone.
Until	Enter the end date range (in ISO 8601 format) to display schedule entries. Example: 2015-07-17T08:42:58.315+0000	Text	Optional	The default value is two weeks after the date range specified in the since parameter.

Example Request

[
  {
    "since": "2024-11-22T07:30:40Z",
    "until": "2025-01-22T07:30:40Z",
    "overflow": true,
    "schedule_id": "P9WNWWZ"
  }
]

Action: Get Teams

This action retrieves all teams.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Query	Filters the result, showing only the tags whose labels match the query.	Text	Optional
Limit	Enter the number of results per page.	Integer	Optional	Default value: 100
Offset	Enter the offset to start pagination search results.	Integer	Optional	Default value: 0
Total	Choose true to retrieve the count of records matching the query.	Boolean	Optional	Default value: false

Example Request

[
  {
    "limit": "2",
    "query": "Functional",
    "total": true,
    "offset": "0"
  }
]

Action: Get User

This action retrieves the details of a user.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
User ID	Enter the user ID of a user to retrieve user details. Example: PPFFJMM	Text	Required
Include	Enter the array of additional details to include.	List	Optional	Allowed values: contact_methods, notification_rules, teams, subdomains

Parameter

Description

Field Type

Required/Optional

Comments

User ID

Enter the user ID of a user to retrieve user details.

Example:

PPFFJMM

Text

Required

Include

Enter the array of additional details to include.

List

Optional

Allowed values:

contact_methods, notification_rules, teams, subdomains

Example Request

[
  {
    "include": [
      "contact_methods",
      "teams"
    ],
    "user_id": "PPFFJMM"
  }
]

Action: Get Users on Call for Schedule

This action retrieves the users on call for a schedule.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Schedule ID	Enter a schedule ID. Example: p5yr9xt	Text	Required
Since	Enter the start date range (in ISO 8601 format) to display schedule entries. Example: 2015-07-17T08:42:58.315+0000	Text	Optional	The default value is two weeks before the date range specified in the until parameter.
Until	Enter the end date range (in ISO 8601 format) to display schedule entries. Example: 2015-07-17T08:42:58.315+0000	Text	Optional	The default value is two weeks after the date range specified in the since parameter.

Parameter

Description

Field Type

Required/Optional

Comments

Schedule ID

Enter a schedule ID.

Example:

p5yr9xt

Text

Required

Since

Enter the start date range (in ISO 8601 format) to display schedule entries.

Example:

2015-07-17T08:42:58.315+0000

Text

Optional

The default value is two weeks before the date range specified in the until parameter.

Until

Enter the end date range (in ISO 8601 format) to display schedule entries.

Example:

2015-07-17T08:42:58.315+0000

Text

Optional

The default value is two weeks after the date range specified in the since parameter.

Example Request

[
  {
    "since": "2024-11-22T07:30:40Z",
    "until": "2025-01-22T07:30:40Z",
    "schedule_id": "P9WNWWZ"
  }
]

Action: List Incidents

This action retrieves a list of existing incidents. An incident represents a problem or an issue that needs to be addressed and resolved.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Limit	Enter the maximum number of results to be displayed. Example: 80	Integer	Optional	Default value: 100
Offset	Enter the offset. Example: 10	Integer	Optional	Default value: 0
Incident Key	Enter the incident de-duplication key. Example: baf7cf21b1da41b4b0221008339ff357	Text	Optional	Incidents with child alerts do not have an incident key. Querying by incident key will return incidents whose alerts have alert_key matching the given incident key.
Service IDs	Enter the service IDs to list incidents for only the specified service IDs. Example: $LIST[ps6anjz, qs6anjz]	List	Optional
Since	Enter the start date from which you need to list incidents. Example: "2022-06-06T15:28:51-05:00"	Text	Optional	Maximum range: 6 months Default range: 1 month
Until	Enter the end date until which you need to list incidents. Example: "2022-07-22T12:36:00-06:00"	Text	Optional	Maximum range: 6 months Default range: 1 month
Status	Enter the status to display only incidents with the specified status. Example: triggered	Text	Optional	Allowed values: triggered, acknowledged, resolved
Team IDs	Enter the team IDs to list incidents for only the specified team IDs. Example: $LIST[pw6anjz, as2anjz]	List	Optional	PagerDuty account must have the teams ability to use this parameter.
Urgencies	Enter the urgencies to list the incidents related to the specified urgencies. Example: $LIST[high]	List	Optional	Allowed values: high low PagerDuty account must have the urgencies ability to use this parameter. If this parameter is not used, then incidents with all urgency types are returned.
User IDs	Enter the user IDs to list incidents currently assigned to only the specified user IDs. Example: $LIST[ks6anfz, qs3adjz]	List	Optional	When using the User IDs parameter, you will only receive incidents with statuses of trigger or acknowledge. This is because resolved incidents are not assigned to any user.
Query Params	Enter the query parameters to make the request.	Key value	Optional	Allowed keys: total, date_range, sort_by, include, time_zone

Example Request

[
    {
        "limit": 80,
        "offset": 10, 
        "incident_key": "baf7cf21b1da41b4b0221008339ff357"
        "service_ids": ["rs6anjz", "ps6anjz"],
        "since": "2022-06-06T15:28:51-05:00",
        "until": "2022-07-22T12:36:00-06:00",
        "status": "triggered",
        "team_ids": ["pw6anjz", "as2anjz"],
        "urgencies": ["high"],
        "user_ids": ["ks6anfz", "qs3adjz"]   
    }

Action: List Schedules

This action retrieves the schedules. A schedule is a time period for which users are on-call.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Query	Enter a query to filter the result of this action and display only the tags whose labels match the query.	Text	Optional
Limit	Enter the maximum number of results to be displayed per page. Example: 80	Integer	Optional	Default value: 100
Offset	Enter the offset. Example: 10	Integer	Optional	Default value: 0
Total	Choose true to retrieve the count of records matching the query.	Boolean	Optional	Default value: false
Include	Enter the array of additional details to include.	List	Optional	Allowed value: schedule_layers
Time Zone	Enter the time zone to display the results.	Text	Optional

Example Request

[
  {
    "limit": "2",
    "query": "Test",
    "total": true,
    "offset": "0",
    "include": [
      "schedule_layers"
    ]
  }
]

Action: List Users

This action lists the users of your PagerDuty account. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Query	Enter a query to filter the result of this action and display only the tags whose labels match the query.	Text	Optional
Limit	Enter the maximum number of results to be displayed per page. Example: 80	Integer	Optional	Default value: 100
Offset	Enter the offset. Example: 10	Integer	Optional	Default value: 0
Total	Choose true to retrieve the count of records matching the query.	Boolean	Optional	Default value: false
Include	Enter the array of additional details to include.	List	Optional	Allowed values: contact_methods, notification_rules, teams, subdomains
Team IDs	Enter a list of team IDs to list users of only specified teams. Example: $LIST[1,2,3]	List	Optional	PagerDuty account must have the teams ability to use this parameter.

Example Request

[
  {
    "limit": "2",
    "query": "Abdul",
    "total": true,
    "offset": "0",
    "include": [
      "contact_methods",
      "teams"
    ],
    "team_ids": [
      "PYTK79C"
    ]
  }
]

Action: PagerDuty Delete Schedule

This action deletes a call schedule.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Schedule ID	Enter a schedule ID to delete a call schedule. Example: "p5yr9xt"	Text	Required

Parameter

Description

Field Type

Required/Optional

Comments

Schedule ID

Enter a schedule ID to delete a call schedule.

Example:

"p5yr9xt"

Text

Required

Example Request

[
  {
    "id": "p5yr9xt"
  }
]

Action: Send an Event

This action sends an event (alert) to Pagerduty.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Summary	Enter the summary of an event. Example: disk at 99% on machine	Text	Required
Severity	Enter the severity of an event. Example: critical	Text	Required	Allowed values: critical, warning, error, info
Source	Enter the unique location of an affected system, preferably a Hostname or Fully Qualified Domain Name (FQDN). Example: windows_host.example.com	Text	Required
Routing Key	Enter the routing key. This is a 32-character integration key for the integration of a Service. Example: R02B6XB3G3KG7UGAEQ0KSEWVL040S9ZP	Text	Required
Event Action	Enter the type of event. Example: acknowledge	Text	Required	Allowed values: trigger, acknowledge, resolve
Dedup Key	Enter a deduplication key to identify the alert to trigger, acknowledge, or resolve. The maximum permitted length of this deduplication key is 255 characters.	Text	Optional	If the value of event action parameter is trigger, then this parameter is not required.
Links	Enter an array of link objects. Example: $JSON[{"href":"http://www.<sampledomain>.com", "text":"cyber fusion. next-generation soar and threat intelligence solved"}]	Any	Optional
Additional Payload Fields	Enter the additional fields to include in the payload.	Key value	Optional	Allowed keys: timestamp, component, group, class_of_event, custom_details
Additional Fields	Enter the additional fields to make the request.	Key value	Optional	Allowed keys: client, client_url, images

Example Request

[
    {
        "summary": "Disk at 99% on machine",
        "severity": "critical", 
        "source": "windows_host.example.com",
        "routing_key": "R02B6XB3G3KG7UGAEQ0KSEWVL040S9ZP",
        "event_action": "acknowledge",
        "dedup_key": "<samplededupkey>",
        "links": [
            {
        "href": "https://<sampledomain>.com/",
        "text": "Cyber fusion. next-generation soar and threat intelligence solved"
            }
         ],
        "extra_fields": {
            "images": [
                {
                    "src": "https://chart.googleapis.com/chart?chs=600x400&chd=t:6,2,9,5,2,5,7,4,8,2,1&cht=lc&chds=a&chxt=y&chm=D,0033FF,0,0,5,1"
                }
            ]
        }
     }
]

Action: Generic Action

This is a generic action used to make requests to any PagerDuty endpoint.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Method	Enter the HTTP method to make the request.	Text	Required	Allowed values: GET, PUT, POST, DELETE
Endpoint	Enter the endpoint to make the request to. Example: v2/enqueue	Text	Required
Query Params	Enter the query parameters to pass to the API.	Key-Value	Optional
Payload	Enter the payload to pass to the API.	Any	Optional
Extra Fields	Enter the extra fields to pass to the API.	Key-Value	Optional	Allowed keys: headers, payload_json, download, files, filename, retry_wait, retry_count, custom_output, response_type

Example Request

[
  {
    "method": "GET",
    "endpoint": "/incidents",
    "extra_fields": {},
    "query_params": {
      "limit": "5",
      "total": "true",
      "offset": "25"
    }
  }
]

Was this helpful?

Would you like to provide feedback? Just click here to suggest edits.

Cyware Orchestrate

PagerDuty

About App

Configuration Parameters

Action: Delete User

Action: Get Incident

Action: Get on Call Entries

Action: Get Schedule

Action: Get Teams

Action: Get User

Action: Get Users on Call for Schedule

Action: List Incidents

Action: List Schedules

Action: List Users

Action: PagerDuty Delete Schedule

Action: Send an Event

Action: Generic Action

Search results