Required Fields for incident Declaration

Required Fields in FireHydrant allow you to define which pieces of information are absolutely necessary for your responders to include when declaring an incident. If these fields are missing, then the incident cannot be declared, with the exception of Scheduled Maintenances, which bypass the required fields.

Note: Currently, Required Fields only apply for declaring incidents.

Configuration

Required fields settings
Required fields settings
  1. To configure, go to Settings > Incident Settings.
  2. Scroll down Incident Fields. From here, you’ll have the capability to edit the default fields or custom fields and make them required.

Saving this form will enforce global validation for the selected fields across all incident declaration methods.

Required field usage

Let’s take a look at a couple different scenarios with the ‘description’ field set as required.

Web UI

When trying to declare an incident through the web UI, you’ll see an error after submission informing a user that the Description field is required.

Unmet requirement prevents submission
Unmet requirement prevents submission

Slack

When declaring an incident through Slack the description field is marked as required, which won’t allow you to submit the form without a value in that field.

Required field example within Slack
Required field example within Slack

In addition, any Required Fields will also show up automatically in both Advanced and Multi-Step type modals for Slack.

API

Making an API request to open an incident will return this error message in the response 

{"detail":"","messages":["description Must be set"],"meta":{}}%

Additional notes

  1. Severity - if severity is required, a user must select a severity other than UNSET before opening the incident.

    Severity must be a value other than UNSET
    Severity must be a value other than UNSET

Last updated on 2/9/2024