Escalation Paths

API endpoints for escalation paths

The escalation path object

id · string · required

Unique identifier for this escalation path.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

kind · enum<string> · required

Whether this path carries its own nodes, or is built from an escalation path template.

Available options: standalone, templated

Example:

"templated"

name · string · required

The name of this escalation path, for the user's reference.

Example:

"Urgent Support"

path · object[] · required

The nodes that form the levels and branches of this escalation path. Empty for a templated path, which takes them from its template.

Show child attributes

Example:

[
  {
    "delay": {
      "delay_interval_condition": "active",
      "delay_seconds": 300,
      "delay_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
    },
    "escalation_path": {
      "escalation_path_id": "01FCNDV6P870EA6S7TK1DSYDG0"
    },
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "if_else": {
      "conditions": [
        {
          "operation": {
            "label": "Lawrence Jones",
            "value": "01FCQSP07Z74QMMYPDDGQB9FTG"
          },
          "param_bindings": [
            {
              "array_value": [
                {
                  "label": "Lawrence Jones",
                  "literal": "SEV123",
                  "reference": "incident.severity"
                }
              ],
              "value": {
                "label": "Lawrence Jones",
                "literal": "SEV123",
                "reference": "incident.severity"
              }
            }
          ],
          "subject": {
            "label": "Incident Severity",
            "reference": "incident.severity"
          }
        }
      ],
      "else_path": [{}],
      "then_path": [{}]
    },
    "level": {
      "ack_mode": "all",
      "retry_config": { "attempts": 3, "interval_seconds": 300 },
      "round_robin_config": {
        "enabled": false,
        "rotate_after_seconds": 120
      },
      "targets": [
        {
          "id": "lawrencejones",
          "schedule_mode": "currently_on_call",
          "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "type": "schedule",
          "urgency": "high"
        }
      ],
      "time_to_ack_interval_condition": "active",
      "time_to_ack_seconds": 1800,
      "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
    },
    "notify_channel": {
      "targets": [
        {
          "id": "lawrencejones",
          "schedule_mode": "currently_on_call",
          "selected_rota_id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "type": "schedule",
          "urgency": "high"
        }
      ],
      "time_to_ack_interval_condition": "active",
      "time_to_ack_seconds": 1800,
      "time_to_ack_weekday_interval_config_id": "01FCNDV6P870EA6S7TK1DSYDG0"
    },
    "repeat": {
      "repeat_times": 3,
      "to_node": "01FCNDV6P870EA6S7TK1DSYDG0"
    },
    "type": "if_else"
  }
]

team_ids · string[] · required

IDs of the teams that own this escalation path. This will automatically sync escalation paths with the right teams in Catalog. If you have an escalation paths attribute on your Teams, this attribute is required.

Example:

["01JPQA75EPNEES4479P16P4XAB"]

current_responders · object[]

Users who are currently on-call for this escalation path

Show child attributes

Example:

[
  {
    "email": "[e-mail]",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Lisa Karlin Curtis",
    "role": "owner",
    "slack_user_id": "U02AYNF2XJM"
  }
]

param_bindings · object

For a templated path, the values bound to the template's declared parameters, keyed by parameter name.

Show child attributes

Example:

{
  "abc123": {
    "array_value": [
      {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    ],
    "value": {
      "label": "Lawrence Jones",
      "literal": "SEV123",
      "reference": "incident.severity"
    }
  }
}

repeat_config · object

Show child attributes

Example:

{
  "delay_repeat_on_activity": false,
  "repeat_after_seconds": 1800
}

template_id · string

For a templated path, the template it is built from.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

working_hours · object[]

The working hours for this escalation path. Absent for a templated path, which takes them from its template.

Show child attributes

Example:

[
  {
    "id": "abc123",
    "name": "abc123",
    "timezone": "abc123",
    "weekday_intervals": [
      {
        "end_time": "17:00",
        "start_time": "09:00",
        "weekday": "monday"
      }
    ]
  }
]