Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- Audits
- Authorizations
- CatalogEntities
- CatalogEntityProperties
- CatalogFields
- Catalogs
- Causes
- [DEPRECATED] CustomFieldOptions
- [DEPRECATED] CustomFields
- CustomForms
- DashboardPanels
- Dashboards
- Environments
- EscalationPolicies
- EscalationLevelsPolicies
- EscalationLevelsPath
- EscalationLevels
- EscalationPaths
- FormFieldOptions
- FormFieldPlacementConditions
- FormFieldPlacements
- FormFieldPositions
- FormFields
- FormSetConditions
- FormSets
- Functionalities
- WorkflowTasks
- [DEPRECATED] WorkflowCustomFieldSelections
- WorkflowFormFieldConditions
- WorkflowGroups
- WorkflowRuns
- Workflows
- Heartbeats
- IncidentActionItems
- [DEPRECATED] IncidentCustomFieldSelections
- IncidentEventFunctionalities
- IncidentEventServices
- IncidentEvents
- IncidentFeedbacks
- IncidentFormFieldSelections
- IncidentPermissionSetBooleans
- IncidentPermissionSetResources
- IncidentPermissionSets
- IncidentRetrospectives
- IncidentRetrospectiveSteps
- IncidentRoleTasks
- IncidentRoles
- IncidentStatusPageEvents
- IncidentSubStatuses
- IncidentTypes
- Incidents
- IpRanges
- LiveCallRouters
- OnCallRoles
- OnCallShadows
- OverrideShifts
- PlaybookTasks
- Playbooks
- RetrospectiveTemplates
- Pulses
- RetrospectiveConfigurations
- RetrospectiveProcessGroupSteps
- RetrospectiveProcessGroups
- RetrospectiveProcesses
- RetrospectiveSteps
- Roles
- ScheduleRotationActiveDays
- ScheduleRotationUsers
- ScheduleRotations
- Schedules
- Shifts
- Secrets
- Services
- Severities
- StatusPageTemplates
- StatusPages
- SubStatuses
- Teams
- UserNotificationRules
- Users
- WebhooksDeliveries
- WebhooksEndpoints
Creates a Form Field
Creates a new form_field from provided data
curl --request POST \
--url https://api.rootly.com/v1/form_fields \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'{
"data": {
"id": "9c071fab-d6c5-4424-96d8-89e29a1b5ca1",
"type": "form_fields",
"attributes": {
"team_id": 119,
"slug": "test-custom-field",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Test custom field",
"description": null,
"shown": [
"web_new_incident_form",
"slack_new_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-03-07T00:03:46.988-08:00",
"created_at": "2025-03-07T00:03:46.988-08:00"
},
"relationships": {
"options": {
"data": []
},
"positions": {
"data": [
{
"id": "01e39ba2-c739-49c9-8250-baf4ee935c57",
"type": "form_field_positions"
},
{
"id": "71b75b74-a9c4-4598-9088-652eb74a4999",
"type": "form_field_positions"
}
]
}
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
form_fields The kind of the form field
custom, title, summary, mitigation_message, resolution_message, severity, environments, types, services, causes, functionalities, teams, visibility, mark_as_test, mark_as_backfilled, labels, notify_emails, trigger_manual_workflows, show_ongoing_incidents, attach_alerts, mark_as_in_triage, in_triage_at, started_at, detected_at, acknowledged_at, mitigated_at, resolved_at, closed_at, manual_starting_datetime_field The name of the form field
The input kind of the form field
text, textarea, select, multi_select, date, datetime, number, checkbox, tags, rich_text The value kind of the form field
inherit, group, service, functionality, user, catalog_entity The ID of the catalog used when value_kind is catalog_entity
The description of the form field
Where the form field is shown. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, incident_post_mortem, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form
Where the form field is required. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form
Whether the form field is shown on the incident details panel
Whether the form field is enabled
The default values.
Response
Unique ID of the form field
form_fields The kind of the form field
custom, title, summary, mitigation_message, resolution_message, severity, environments, types, services, causes, functionalities, teams, visibility, mark_as_test, mark_as_backfilled, labels, notify_emails, trigger_manual_workflows, show_ongoing_incidents, attach_alerts, mark_as_in_triage, in_triage_at, started_at, detected_at, acknowledged_at, mitigated_at, resolved_at, closed_at, manual_starting_datetime_field The input kind of the form field
text, textarea, select, multi_select, date, datetime, number, checkbox, tags, rich_text The value kind of the form field
inherit, group, service, functionality, user, catalog_entity The name of the form field
The slug of the form field
Where the form field is shown. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, incident_post_mortem, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form
Where the form field is required. Add custom forms using the custom form's slug field. Or choose a built-in form: web_new_incident_form, web_update_incident_form, web_incident_post_mortem_form, web_incident_mitigation_form, web_incident_resolution_form, web_incident_cancellation_form, web_scheduled_incident_form, web_update_scheduled_incident_form, slack_new_incident_form, slack_update_incident_form, slack_update_incident_status_form, slack_incident_mitigation_form, slack_incident_resolution_form, slack_incident_cancellation_form, slack_scheduled_incident_form, slack_update_scheduled_incident_form
The default values.
Date of creation
Date of last update
The ID of the catalog used when value_kind is catalog_entity
The description of the form field
Whether the form field is shown on the incident details panel
Whether the form field is enabled
Was this page helpful?
curl --request POST \
--url https://api.rootly.com/v1/form_fields \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'{
"data": {
"id": "9c071fab-d6c5-4424-96d8-89e29a1b5ca1",
"type": "form_fields",
"attributes": {
"team_id": 119,
"slug": "test-custom-field",
"kind": "custom",
"input_kind": "text",
"value_kind": "inherit",
"value_kind_catalog_id": null,
"name": "Test custom field",
"description": null,
"shown": [
"web_new_incident_form",
"slack_new_incident_form"
],
"required": [],
"default_values": [],
"show_on_incident_details": true,
"enabled": true,
"updated_at": "2025-03-07T00:03:46.988-08:00",
"created_at": "2025-03-07T00:03:46.988-08:00"
},
"relationships": {
"options": {
"data": []
},
"positions": {
"data": [
{
"id": "01e39ba2-c739-49c9-8250-baf4ee935c57",
"type": "form_field_positions"
},
{
"id": "71b75b74-a9c4-4598-9088-652eb74a4999",
"type": "form_field_positions"
}
]
}
}
}
}