Skip to main content
Configure your alert routes in incident.io. Alert routes define how alerts from different sources are processed, grouped, and routed to the right teams and people.

​
The alert route object

​
alert_sources
object[]
required

Which alert sources should this alert route match?

Example:
[
  {
    "alert_source_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "condition_groups": [
      {
        "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"
            }
          }
        ]
      }
    ]
  }
]
​
channel_config
object[]
required

The channel configuration for this alert route

Example:
[
  {
    "condition_groups": [
      {
        "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"
            }
          }
        ]
      }
    ],
    "ms_teams_targets": {
      "binding": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      },
      "channel_visibility": "abc123"
    },
    "slack_targets": {
      "binding": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      },
      "channel_visibility": "abc123"
    }
  }
]
​
condition_groups
object[]
required

What condition groups must be true for this alert route to fire?

Example:
[
  {
    "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"
        }
      }
    ]
  }
]
​
enabled
boolean
required

Whether this alert route is enabled or not

Example:

false

​
escalation_config
object
required
Example:
{
  "auto_cancel_escalations": false,
  "escalation_targets": [
    {
      "escalation_paths": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      },
      "users": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      }
    }
  ]
}
​
expressions
object[]
required

The expressions used in this template

Example:
[
  {
    "else_branch": {
      "result": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      }
    },
    "label": "Team Slack channel",
    "operations": [
      {
        "branches": {
          "branches": [
            {
              "condition_groups": [
                {
                  "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"
                      }
                    }
                  ]
                }
              ],
              "result": {
                "array_value": [
                  {
                    "label": "Lawrence Jones",
                    "literal": "SEV123",
                    "reference": "incident.severity"
                  }
                ],
                "value": {
                  "label": "Lawrence Jones",
                  "literal": "SEV123",
                  "reference": "incident.severity"
                }
              }
            }
          ],
          "returns": { "array": true, "type": "IncidentStatus" }
        },
        "filter": {
          "condition_groups": [
            {
              "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"
                  }
                }
              ]
            }
          ]
        },
        "navigate": {
          "reference": "1235",
          "reference_label": "Teams"
        },
        "operation_type": "navigate",
        "parse": {
          "returns": { "array": true, "type": "IncidentStatus" },
          "source": "metadata.annotations[\"github.com/repo\"]"
        },
        "returns": { "array": true, "type": "IncidentStatus" }
      }
    ],
    "reference": "abc123",
    "returns": { "array": true, "type": "IncidentStatus" },
    "root_reference": "incident.status"
  }
]
​
id
string
required

Unique identifier for this alert route config

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
incident_config
object
required
Example:
{
  "auto_decline_enabled": false,
  "auto_relate_grouped_alerts": false,
  "condition_groups": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "defer_time_seconds": 1,
  "enabled": false,
  "grouping_keys": [{ "reference": "alert.title" }],
  "grouping_window_seconds": 1
}
​
incident_template
object
required
Example:
{
  "custom_fields": [
    {
      "binding": {
        "array_value": [
          {
            "label": "Lawrence Jones",
            "literal": "SEV123",
            "reference": "incident.severity"
          }
        ],
        "value": {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      },
      "custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "merge_strategy": "first-wins"
    }
  ],
  "incident_mode": {
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  },
  "incident_type": {
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  },
  "name": {
    "autogenerated": false,
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  },
  "severity": {
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    },
    "merge_strategy": "first-wins"
  },
  "start_in_triage": {
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  },
  "summary": {
    "autogenerated": false,
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  },
  "workspace": {
    "binding": {
      "array_value": [
        {
          "label": "Lawrence Jones",
          "literal": "SEV123",
          "reference": "incident.severity"
        }
      ],
      "value": {
        "label": "Lawrence Jones",
        "literal": "SEV123",
        "reference": "incident.severity"
      }
    }
  }
}
​
is_private
boolean
required

Whether this alert route is private. Private alert routes will only create private incidents from alerts.

Example:

false

​
name
string
required

The name of this alert route config, for the user's reference

Example:

"Production incidents"

​
version
integer<int64>
required

The version of this alert route config

Example:

1

​
created_at
string<date-time>

The time of creation of this alert route

Example:

"2021-08-17T13:28:57.801578Z"

​
message_template
object
Example:
{
  "array_value": [
    {
      "label": "Lawrence Jones",
      "literal": "SEV123",
      "reference": "incident.severity"
    }
  ],
  "value": {
    "label": "Lawrence Jones",
    "literal": "SEV123",
    "reference": "incident.severity"
  }
}
​
owning_team_ids
string[]

IDs of teams that own this alert route

Example:
["01G0J1EXE7AXZ2C93K61WBPYEH"]
​
updated_at
string<date-time>

The time of last update of this alert route

Example:

"2021-08-17T13:28:57.801578Z"