Settings for Incident Types

The Blameless API provides endpoints to read and update incident type configurations. Working with these endpoints requires understanding of the following Blameless concepts.

Incident Types and Severities

Incident management configurations are grouped by the types and severities of incidents. This enables both high level configurations to be defined for a given incident type, while also providing fine grained control by enabling the modification of settings for a specific severity.

When incident settings are accessed or modified, the request must include the type and severity of the incidents for which the settings are scoped.

Scope Type

This indicates if the settings to fetch and/or modify are scoped to either an incident-type or incident-type-severity.

note

Please refer to the endpoint specific documentation for the exact name of the scope type parameter​.

Scope ID

If the scope type is incident-type, then the scope ID is the type of the incident.

If the scope type is incident-type-severity, then the scope ID is a concatenation of the incident type and severity separated by a dash (i.e., type one-default where type one is the incident type, and default is the severity).

note

Please refer to the endpoint specific documentation for the exact name of the scope ID parameter​. Depending on the endpoint, the scope type and ID are specified via query parameters or by providing them as part of the JSON payload.

Setting IDs

Each configuration is referenced by an identifier - the following table provides details about the configurations relevant to incident management.

Setting IDTypeRequiredValue Example
org.incident.checklist-tasksobject{ "INVESTIGATING": [ { "owner": { "type": "ROLE", "owner": "CREATOR" }, "description": "Assign" } ] }
org.incident.tag-categoriesobject{ "CONTRIBUTING-FACTOR": [], "SERVICE": [], "CUSTOMER": [], "PRODUCT": [] }
org.incident.force-create-incident-via -webhookbooltrue, false
org.incident.naming-schemestring“NUMERIC”, “DATE”, “PETNAME”, “ISSUENAME”
org.incident.privatebooltrue, false
org.incident.invited-slack-groupsstring[][“slack-group-name”, “@slack-user”]
org.incident.announcement-channelsstring[][“slack-channel-1”, “slack-channel-2”]
org.postmortem.analysis-templatestringMarkdown text here”
org.postmortem.custom-input-formstring“{}”
org.postmortem.completion-slaint14 (days)
org.postmortem.is-requiredbooltrue, false
org.postmortem.completion-reminderbooltrue, false
org.integration.pagerduty-auto-triggerbooltrue, false
org.integration.auto-trigger-alert.pagerduty-service-idsstring[][“P123ABC”, “P234BCD”]
org.incident.creator-to-rolestring“U123ABC”
org.integration.jira-incident-ticket-projectstring“Blameless”
org.integration.jira-incident-ticket-typestring“Bug”
org.jira.incident_required_field.*string“incident.description”
org.incident.use-business-daysbooltrue, false