PagerDuty
PagerDuty is a cloud computing company that produces a SaaS incident response platform for IT departments.
App Vendor: PagerDuty
App Category: IT Services
Connector Version: 2.0.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 All Schedules | This action retrieves the schedules. |
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 User | This action retrieves the details of a user. |
List Incidents | This action lists incidents. |
List Users | This action lists the users of a PagerDuty account. |
PagerDuty Delete Schedule | This action deletes a call schedule. |
PagerDuty Get Users on Call for Schedule | This action retrieves the users on-call for a schedule. |
Send an Event | This action sends an event (alert) to Pagerduty. |
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 | |
Verify SSL | Choose to verify the SSL certificates. | Boolean | Optional | Allowed values:
|
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 |
Example Request
[
{
"id": "ps6anjz"
}
]
Action: Get All 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 |
Example Request
[
{
"limit": 80,
"offset": 10
}
]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: "q24t75xgybrpki" | Text | Required |
Example Request
[
{
"incident_id": "q24t75xgybrpki"
}
]
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 |
|
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:
|
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 |
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 |
Example Request
[
{
"schedule_id": "P5YR9XT"
}
]Action: Get User
This action retrieves the details of a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the user ID of a user to retrieve user details. Example: "ps6anjz" | Text | Required |
Example Request
[
{
"user_id": "PS6ANJZ"
}
]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 |
|
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:
|
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:
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. |
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 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 |
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": 80,
"offset": 10,
"team_ids": ["1", "2", "3"]
}
]Action: PagerDuty Delete Schedule
This action deletes a call schedule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter a schedule ID to delete a call schedule. Example: "p5yr9xt" | Text | Required |
Example Request
[
{
"id": "p5yr9xt"
}
]
Action: PagerDuty 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 |
Example Request
[
{
"schedule_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:
|
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 on a Service. Example: "R02B6XB3G3KG7UGAEQ0KSEWVL040S9ZP" | Text | Required | |
Event Action | Enter the type of event. Example: "acknowledge" | Text | Required | Allowed values:
|
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 |
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"
}
]
}
]