Incident Forms
API endpoints for incident forms
Configure the forms used to declare, accept, update, and resolve incidents.
Each form carries its elements and the expressions those elements can reference.
Escalate forms are not part of this API.
The incident form object
When this incident form was created
Example:
"2021-08-17T13:28:57.801578Z"
Expressions available to every element's conditions and defaults. Referenced by reference, not by ID.
Show child attributes
Show child attributes
Example:
[
{
"else_branch": {
"result": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"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": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
],
"result": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": { "array": true, "type": "IncidentStatus" }
},
"cast": {
"returns": { "array": true, "type": "IncidentStatus" }
},
"concatenate": {
"reference": "1235",
"reference_label": "Teams"
},
"filter": {
"condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
]
},
"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"
}
]
Which form this is. Escalate forms are not part of this API.
Available options:
declare, accept, update, resolve, retrospective, custom-fields Example:
"declare"
Unique identifier for this incident form
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
When this incident form was last updated
Example:
"2021-08-17T13:28:57.801578Z"
The incident type this form belongs to. Unset for the organisation's default form of this type.
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Elements on this form, in display order. List position is the order: there is no separate rank.
Show child attributes
Show child attributes
Example:
[
{
"can_select_no_value": false,
"config": { "require_comment": false },
"custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"default_value": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
},
"description": "Shown when the incident is major or above.",
"element_type": "name",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_role_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"placeholder": "What's happening?",
"required_if": "check_engine_config",
"required_if_condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
],
"show_if_condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
]
}
]
Was this page helpful?
{
"created_at": "2021-08-17T13:28:57.801578Z",
"expressions": [
{
"else_branch": {
"result": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"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": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
],
"result": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
}
],
"returns": {
"array": true,
"type": "IncidentStatus"
}
},
"cast": {
"returns": {
"array": true,
"type": "IncidentStatus"
}
},
"concatenate": {
"reference": "1235",
"reference_label": "Teams"
},
"filter": {
"condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
]
},
"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"
}
],
"form_type": "declare",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"updated_at": "2021-08-17T13:28:57.801578Z",
"incident_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"lifecycle_elements": [
{
"can_select_no_value": false,
"config": {
"require_comment": false
},
"custom_field_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"default_value": {
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
},
"description": "Shown when the incident is major or above.",
"element_type": "name",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_role_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_timestamp_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"placeholder": "What's happening?",
"required_if": "check_engine_config",
"required_if_condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
],
"show_if_condition_groups": [
{
"conditions": [
{
"operation": {
"label": "Lawrence Jones",
"value": "01FCQSP07Z74QMMYPDDGQB9FTG"
},
"param_bindings": [
{
"array_value": [
{
"literal": "SEV123",
"reference": "incident.severity"
}
],
"value": {
"literal": "SEV123",
"reference": "incident.severity"
}
}
],
"subject": {
"label": "Priority",
"reference": "alert.priority"
}
}
]
}
]
}
]
}