Skip to content

Commit 59d0e3b

Browse files
authored
Add a Field names section to the incident property fields page (#32654)
Incident property fields have a name and a display name so we want a few sentences to describe their differences.
1 parent c719784 commit 59d0e3b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

content/en/service_management/incident_management/incident_settings/property_fields.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ You can define new fields of any of the following field types:
5757
**Datetime**
5858
: Accepts any datetime. Values are stored in UTC and are parsed and formatted using the user's local timezone.
5959

60+
### Field names
61+
62+
A field's name is a snake-case identifier used in [search and analytics queries][12], [Workflow automations][13], and APIs. Its display name is a user-friendly label that determines how the field appears in an [incident's overview page][1], an [incident's timeline][10], and the [incident declaration modal][11].
63+
6064
### Required at declaration
6165

6266
If you mark a field as "Required at Declaration," users are required to enter a value when declaring incidents. This option does not affect Datadog Workflow automations or API requests.
@@ -83,4 +87,8 @@ In Incident Management Analytics, number fields appear as measures that can be g
8387
[6]: /getting_started/tagging/using_tags/?tab=assignment#metrics
8488
[7]: /dashboards/
8589
[8]: /notebooks/
86-
[9]: /service_management/incident_management/incident_settings/notification_rules
90+
[9]: /service_management/incident_management/incident_settings/notification_rules
91+
[10]: /service_management/incident_management/investigate/timeline
92+
[11]: /service_management/incident_management/declare
93+
[12]: /service_management/incident_management/incident_settings/property_fields#custom-fields-in-search-and-analytics
94+
[13]: /actions/workflows/

0 commit comments

Comments
 (0)