URL parameters
The ID of the escalation policy you want to update
Headers
Bearer $TOKEN
application/json
Body parameters
The name of this Policy.
How many times should the entire policy be repeated if no one acknowledges the incident.
How long in seconds to wait before each repetition.
An array of escalation policy steps, run in order. Sending steps replaces all existing steps of the policy. Each step accepts the fields below.
The type of the step: escalation notifies people or integrations, time_branching and metadata_branching act when the incident matches a time window or a metadata value, instructions posts instructions into the incident timeline, and resolve_remove resolves or removes the incident.
How long to wait in seconds before running this step, counted from the previous step. Between 0 and 691200, which is 8 days. Defaults to 0. Omit when you set wait_until_time.
Run this step at this time of day instead of after wait_before, in HH:MM format. Requires wait_until_timezone.
The time zone of wait_until_time. The accepted values can be found in the Rails TimeZone documentation.
The days on which wait_until_time applies, as an array of mon, tue, wed, thu, fri, sat, and sun. Defaults to every day.
The ID of the severity that sets how members are notified. Required when type is escalation.
Who or what to notify, at least one member. Required when type is escalation.
What to notify:
current_on_call notifies whoever is on call, and entire_team everyone in the team.
user notifies one person, and policy runs another escalation policy.
incident_metadata notifies the users and escalation policies stored under an incident metadata key.
slack_integration, microsoft_teams_integration, linear_integration, jira_integration, pagerduty_integration, zapier_webhook, webhook, email_integration, zoom_integration, and google_meet_integration each notify one integration.
ai_sre starts an AI SRE investigation.
all_slack_integrations, all_microsoft_teams_integrations, all_linear_integrations, all_jira_integrations, all_zapier_integrations, all_webhook_integrations, all_email_integrations, all_splunk_on_call_integrations, all_incident_io_integrations, all_zoom_integrations, and all_google_meet_integrations notify every integration of that kind.
The ID of the member to notify. Required for user unless you send email, for policy and ai_sre, and for the types that notify one integration. With ai_sre, the ID of the AI SRE integration. With current_on_call, the ID of an on-call calendar whose current on-call to notify instead of the team's default calendar. With entire_team, the ID of another team to notify instead of this policy's team.
The e-mail of the user to notify when type is user, instead of id. The user must be a member of the policy's team.
The incident metadata key whose users and escalation policies to notify. Used when type is incident_metadata.
The time zone of the time window. Required when type is time_branching. The accepted values can be found in the Rails TimeZone documentation.
The days on which the time window applies, as an array of mon, tue, wed, thu, fri, sat, and sun. Used when type is time_branching. Defaults to every day.
Start of the time window, in HH:MM format. Required when type is time_branching.
End of the time window, in HH:MM format. Required when type is time_branching.
The incident metadata key to check. Required when type is metadata_branching.
The metadata values that match, at least one. Required when type is metadata_branching. Each value is a string or an object with a type, as described for values when creating a metadata record. Use { "type": "no_value" } to match an incident where the key is missing or blank.
What to do when the step runs: escalate_to_policy, do_not_escalate, resolve_incident, or remove_incident. Required when type is resolve_remove, which accepts only resolve_incident and remove_incident. On branching steps it applies when the incident matches, and defaults to escalate_to_policy when you set policy_id or policy_metadata_key, and to do_not_escalate otherwise.
The ID of the escalation policy to run when the incident matches. Used when type is time_branching or metadata_branching. Can't be combined with policy_metadata_key.
An incident metadata key holding the escalation policy to run when the incident matches, instead of policy_id. If the key is missing or holds no policy, the policy stops. Used when type is time_branching or metadata_branching.
The instructions to post as a comment into the incident timeline. Supports Markdown, interactive checkboxes like - [ ] Step 1, and incident metadata values as {key}, for example {server_region}. Required when type is instructions.
Whether to post a reminder periodically until every checkbox is checked. Used when type is instructions. Defaults to false.
How often to post the reminder, in hours. At least 1. Used when type is instructions. Defaults to 4.
The ID of an escalation policy to escalate to once this policy has run all its steps and repeats without being acknowledged. Must belong to the same organization. Defaults to null (no further escalation).
The ID of the escalation policy group to put this policy in. Send null to remove the policy from its group.