Skip to main content

Create Escalation Policy

Creates a new escalation policy. At least one escalation rule must be provided.

Escalation policies define which user should be alerted at which time.

For more information see the API Concepts Document.

External Documentation

To learn more, visit the PagerDuty documentation.

Basic Parameters

ParameterDescription
Escalation Policy DescriptionEscalation policy description.
Escalation Policy NameThe name of the escalation policy.
Escalation Policy Num LoopsThe number of times the escalation policy will repeat after reaching the end of its escalation.
Escalation Policy SummaryA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
Escalation RulesThe escalation rules for the escalation policy.An array of rules containing the following rules format:
  • escalation_delay_in_minutes:The number of minutes before an unacknowledged incident escalates away from this rule.This field is required.
  • targets:The targets an incident should be assigned to upon reaching this rule. The number of items allowed are >= 1<= 10 items.This field is required.
  • escalation_rule_assignment_strategy:The strategy used to assign the escalation rule to an incident.Allowed values:
     - round_robin - assign_to_everyone
FromThe email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.

Advanced Parameters

ParameterDescription
Escalation Policy On Call Handoff NotificationsDetermines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "ifhasservices".
Escalation Policy Services-
Escalation Policy TeamsTeams associated with the policy. Account must have the teams ability to use this parameter.

Example Output

{
"summary": "Response Example",
"value": {
"escalation_policy": {
"escalation_rules": [
{
"escalation_delay_in_minutes": 22,
"id": "PT20YPA",
"targets": [
{
"html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
"id": "PXPGF42",
"self": "https://api.pagerduty.com/users/PXPGF42",
"summary": "Earline Greenholt",
"type": "user_reference"
},
{
"html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85",
"id": "PI7DH85",
"self": "https://api.pagerduty.com/schedules/PI7DH85",
"summary": "Daily Engineering Rotation",
"type": "schedule_reference"
}
]
}
],
"html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA",
"id": "PT20YPA",
"name": "Engineering Escalation Policy",
"num_loops": 2,
"on_call_handoff_notifications": "if_has_services",
"self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
"services": [
{
"html_url": "https://subdomain.pagerduty.com/services/PIJ90N7",
"id": "PIJ90N7",
"self": "https://api.pagerduty.com/services/PIJ90N7",
"summary": "My Mail Service",
"type": "service_reference"
}
],
"summary": "Engineering Escalation Policy",
"teams": [
{
"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
"id": "PQ9K7I8",
"self": "https://api.pagerduty.com/teams/PQ9K7I8",
"summary": "Engineering",
"type": "team_reference"
}
],
"type": "escalation_policy"
}
}
}

Workflow Library Example

Create Escalation Policy with Pagerduty and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop