​
Overview

Rootly carefully selected the built-in properties based on common attributes used to characterize incidents. However, not all organizations are built the same and sometimes the built-in properties are not enough to meet everyone’s requirements. To enable a fully bespoke experience, Rootly introduced custom properties that can be set up to meet the exact specifications of your organization’s incident management requirements.

​
Managing Custom Fields

​
Create Field

Select the Create New Form Field button to begin creating a new custom field.
Fill in the following fields and select the Add button to add your custom field.

​
Field Type

This is the general field type, which can only be Custom Field.

​
Name

The value entered here will be the value that appears on user-facing forms. This value WILL dictate how the custom field is referenced in Liquid syntax. This is because the syntax used to reference a custom field uses the slug value, which is the name lower-cased and hyphenated. {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}

​
Field Type

This field allows you to select the field type, which will dictate how the user interacts with this field. For example, a checkbox type will be a boolean field while a select type will ask the user to select one out of many options. For more details on the available field types, please scroll down to the Supported Field Types section.

​
Value Type

This field allows you to select the value type for select and multiple select fields. The following Value types are available: custom text options, teams, services or users.
  • Custom text allows user input to determine what values are available for selection.
  • Teams, Services or Users allow the custom field to pull from one of the existing fields populated in Rootly.
For example, an organization may want to identify both an ‘Owning Team’ as well as a set of ‘Impacted Teams.’ A new custom field could be created for ‘Impacted Teams’ and the existing ‘Teams’ field could be renamed to ‘Owning Team.‘

​
Default Value

Custom fields can be configured to have a default value. For example, if you want all your incidents to default to Unknown for the Root Cause custom field, then you can set it here.

​
Enabled

Only enabled fields are considered to be live fields - meaning they can appear on UI screens and be updated during incidents. Disabled fields are NOT usable during incidents and cannot be updated by workflows either.

​
Display This Field in the Incident Details

This switch allows you to display or hide the specific field on the Details section of the Incident Details page.
Hiding a field from being displayed in the Details section does not mean this field is turned off. It just means users cannot edit it from the UI.
This is typically used when teams want to configure a custom flag that gets systematically set by workflows, not manually by users.

​
Enable/Disable Field

Only enabled fields are considered to be live fields - meaning they can appear on UI screens and be updated during incidents. Disabled fields are NOT usable during incidents and cannot be updated by workflows either. You can use the toggle switch next to the field name to enable/disable it.

​
Edit Field

You can edit a specific field by clicking on the edit icon on the right hand side of the field.
Once selected, you will see an Edit Form Field pane open. From here, you’ll be able to edit the attributes of this particular field.

​
ID

This is an unique identifier for the form field. It is automatically generated for you upon field creation and cannot be edited. This id will be used to reference the specific form field in API calls and Liquid syntaxes.

​
Name

This field can be edited. The value entered here will be the value that appears on user-facing forms. Unlike built-in fields, changing the name of a custom field WILL alter the Liquid syntax used to reference it. This is because the syntax used to reference a custom field uses the slug value, which is the name lower-cased and hyphenated. {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}

​
Description

This field can be used to display a description for the custom field. This is particularly helpful if you want to give your users some instruction on how to fill in the custom field.

​
Field Type

This field allows you to select the field type, which will dictate how the user interacts with this field. For example, a checkbox type will be a boolean field while a select type will ask the user to select one out of many options. For more details on the available field types, please scroll down to the Supported Field Types section.

​
Options

This field allows you to define selectable options for Select and Multiple Select field types when the ‘Custom text’ field value is selected.
  1. Enter the value of the option.
  2. Select the color of the option. This is reflected on metrics graphs.
  3. Drag and drop to re-order the options as they appear in dropdowns.
  4. Delete an option.
  5. Copy the form_field_option_id. This is used in API calls and Liquid syntaxes
  6. Add more options.

​
Default

Custom fields can be configured to have a default value. For example, if you want all your incidents to default to Zone 1 for the Zone custom field, then you can set it here.

​
Enabled

This is the same setting as the toggle described in the Enable/Disable Field section above Only enabled fields are considered to be live fields - meaning they can appear on UI screens and be updated during incidents. Disabled fields are NOT usable during incidents and cannot be updated by workflows either. You can use the toggle switch next to the field name to enable/disable it.

​
Display This Field in the Incident Details

This switch allows you to display or hide the specific field on the Details section of the Incident Details page.
Hiding a field from being displayed in the Details section does not mean this field is turned off. It just means users cannot edit it from the UI.
This is typically used when teams want to configure a custom flag that gets systematically set by workflows, not manually by users.

​
Delete Field

Custom fields can be deleted by clicking the trash symbol.
Deleted fields cannot be recovered. It is highly recommended that you disable unused custom fields instead of deleting them.Deletion should be reserved for only when you’re sure that it won’t be used in the response process anymore.

​
Supported Field Types

Rootly supports various field types. Each field type has their intended use case and Liquid syntax. Below sections goes in more depth on each field type. Custom fields can be referenced either by the field id or slug.
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}
The custom field slug can be obtained by lower-casing and hyphenating the custom field name.
  • If the custom field name is Root Cause, then the slug would be root-cause
The custom field ID can be obtained by opening the edit drawer for a particular field.
  1. Navigate to the custom fields page
  2. Select edit icon for a particular custom field
  3. Copy the ID attribute

​
Text

A text field is used to input single-lined free-form texts, such as names or addresses. The following Liquid syntax will allow you to reference a custom text field:
JS
#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Textarea

A textarea field is used to input multi-lined free-form text, such details or comments. The following Liquid syntax will allow you to reference a custom textarea field:
Liquid
#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Select

A select field is used to select a single value from a list of predefined values. The following Value types are available:
  • Custom text allows user input to determine what values are available for selection.
  • Teams, Services or Users allow the custom field to pull from one of the existing fields populated in Rootly.
The following Liquid syntax will allow you to reference a custom select field:
Liquid
#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options' | map: 'value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options' | map: 'value' }}

​
Multiple Select

A multiple select field is used to select one or more values from a list of predefined values. The following Value types are available:
  • Custom text allows user input to determine what values are available for selection.
  • Teams, Services or Users allow the custom field to pull from existing fields already populated in Rootly.
The following Liquid syntax will allow you to reference a custom multiple select field:
Liquid
#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options' | map: 'value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options' | map: 'value' }}

​
Date

A date field is used to select a specific date. Rootly uses a calendar style date picker on the UI. The following Liquid syntax will allow you to reference a custom date field:
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Datetime

A datetime field is used to select a date and a time. Rootly uses a calendar style date picker and HH:MM AM/PM styled time picker on the UI. The following Liquid syntax will allow you to reference a custom datetime field:
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Users

A users field is used to select one or more users from the list of users in your organization’s Memberships page. The following Liquid syntax will allow you to reference a custom datetime field:
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_users' | map: 'full\_name' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_users' | map: 'full\_name' }}

​
Number

A number field is used to input a numeric value. Rootly enforces that only numeric values can be entered into this field type. The following Liquid syntax will allow you to reference a custom number field:
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Checkbox

A checkbox field is used to select true or false. The following Liquid syntax will allow you to reference a custom checkbox field:
Liquid

#By SLUG {{ incident.custom\_fields | find: 'custom\_field.slug', 'your-custom-field-slug' | get: 'selected\_options.value' }}
#By ID {{ incident.custom\_fields | find: 'custom\_field.id', 'your-custom-field-id' | get: 'selected\_options.value' }}

​
Support

If you need help or more information about this integration, please contact support@rootly.com or start a chat by navigating to Help > Chat with Us.