Skip to content

Add a Field names section to the incident property fields documentation #32654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drichards-87 merged 1 commit into from
Nov 6, 2025
Merged

Add a Field names section to the incident property fields documentation #32654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .../en/service_management/incident_management/incident_settings/property_fields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@
**Datetime**
: Accepts any datetime. Values are stored in UTC and are parsed and formatted using the user's local timezone.

### Field names

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].

Check notice on line 62 in content/en/service_management/incident_management/incident_settings/property_fields.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.sentencelength 

Suggestion: Try to keep your sentence length to 25 words or fewer.

### Required at declaration

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.
Expand All @@ -83,4 +87,8 @@
[6]: /getting_started/tagging/using_tags/?tab=assignment#metrics
[7]: /dashboards/
[8]: /notebooks/
[9]: /service_management/incident_management/incident_settings/notification_rules
[9]: /service_management/incident_management/incident_settings/notification_rules
[10]: /service_management/incident_management/investigate/timeline
[11]: /service_management/incident_management/declare
[12]: /service_management/incident_management/incident_settings/property_fields#custom-fields-in-search-and-analytics
[13]: /actions/workflows/
Loading