Escalation policies API response params

Response body parameters

Namespace data

Parameter Type Values
id String Id of the escalation policy
type String policy
attributes Object Attributes object (see below)
attributes.name String Name of the policy.
attributes.repeat_count Integer How many times should the entire policy be repeated if no one acknowledges the incident.
attributes.repeat_delay Integer How long in seconds to wait before each repetition.
attributes.incident_token String Incident token that can be used for manually reporting incidents.
attributes.steps.[] PolicyStep An array of escalation policy steps. See the PolicyStep section below for attribute details.

PolicyStep

Parameter Type Values
type String The type of the step. Can be either escalation or branching.
wait_before Integer How long to wait before executing this step since previous step.
urgency_id Integer Which severity to use for this step.
timezone String What timezone to use when evaluating time based branching rules. Used when step type is branching. The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
days String[] An array of days during which the branching rule will be executed. Valid values are ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]. Used when step type is branching.
time_from String A time from which the branching rule will be executed. Use HH:MM format. Used when step type is branching.
time_to String A time at which the branching rule will step being executed. Use HH:MM format. Used when step type is branching.
policy_id String A policy to executed if the branching rule matches the time of an incident. Used when step type is branching.
step_members.[] PolicyStepMember An array of escalation policy steps members. See the PolicyStepMember section below for attribute details.

PolicyStepMember

Parameter Type Values
type String Type type of the member to notify during an incident. Can be one of current_on_call, entire_team, all_slack_integrations, all_microsoft_teams_integrations, all_zapier_integrations, all_webhook_integrations, all_splunk_on_call_integrations, user, webhook, slack_integration, microsoft_teams_integration, zapier_webhook.
id String The ID of the resource to notify during an incident. Required for webhook, slack_integration, microsoft_teams_integration and zapier_webhook member types. This is e.g. the ID of the user to notify when type is user.
email String The ID of the user to notify when type is user. For users, one may provide only email, and the id value will be inferred automatically.