Creates a Form Field

POST

form_fields

curl --request POST \
  --url https://api.rootly.com/v1/form_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "form_fields",
    "attributes": {
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "show_on_incident_details": true,
      "enabled": true,
      "default_values": [
        "<string>"
      ]
    }
  }
}'

{
  "data": {
    "id": "55905dc8-0f22-4639-9499-ff6fab30a907",
    "type": "form_fields",
    "attributes": {
      "team_id": 89,
      "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-04-18T09:46:45.599-07:00",
      "created_at": "2025-04-18T09:46:45.599-07:00"
    },
    "relationships": {
      "options": {
        "data": []
      },
      "positions": {
        "data": [
          {
            "id": "fc0bc5a1-8bc9-48a6-a8b4-b2891e4a90ee",
            "type": "form_field_positions"
          },
          {
            "id": "a091893d-43db-48de-a02a-f4a3d6c42806",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

data

object

required

data.type

enum<string>

required

Available options:

form_fields

data.attributes

object

required

data.attributes.kind

enum<string>

required

The kind of the form field

Available options:

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

data.attributes.name

string

required

The name of the form field

data.attributes.input_kind

enum<string>

The input kind of the form field

Available options:

text,

textarea,

select,

multi_select,

date,

datetime,

number,

checkbox,

tags,

rich_text

data.attributes.value_kind

enum<string>

The value kind of the form field

Available options:

inherit,

group,

service,

functionality,

user,

catalog_entity

data.attributes.value_kind_catalog_id

string | null

The ID of the catalog used when value_kind is catalog_entity

data.attributes.description

string | null

The description of the form field

data.attributes.shown

string[]

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

data.attributes.required

string[]

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

data.attributes.show_on_incident_details

boolean

Whether the form field is shown on the incident details panel

data.attributes.enabled

boolean

Whether the form field is enabled

data.attributes.default_values

string[]

The default values.

Response

201

application/vnd.api+json

form_field created

data

object

required

data.id

string

required

Unique ID of the form field

data.type

enum<string>

required

Available options:

form_fields

data.attributes

object

required

data.attributes.kind

enum<string>

required

The kind of the form field

Available options:

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

data.attributes.input_kind

enum<string>

required

The input kind of the form field

Available options:

text,

textarea,

select,

multi_select,

date,

datetime,

number,

checkbox,

tags,

rich_text

data.attributes.value_kind

enum<string>

required

The value kind of the form field

Available options:

inherit,

group,

service,

functionality,

user,

catalog_entity

data.attributes.name

string

required

The name of the form field

data.attributes.slug

string

required

The slug of the form field

data.attributes.shown

string[]

required

data.attributes.required

string[]

required

data.attributes.default_values

string[]

required

The default values.

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.value_kind_catalog_id

string | null

The ID of the catalog used when value_kind is catalog_entity

data.attributes.description

string | null

The description of the form field

data.attributes.show_on_incident_details

boolean

Whether the form field is shown on the incident details panel

data.attributes.enabled

boolean

Whether the form field is enabled

Was this page helpful?

Retrieves a Form FieldRetrieves a specific form_field by id

curl --request POST \
  --url https://api.rootly.com/v1/form_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "form_fields",
    "attributes": {
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "show_on_incident_details": true,
      "enabled": true,
      "default_values": [
        "<string>"
      ]
    }
  }
}'

{
  "data": {
    "id": "55905dc8-0f22-4639-9499-ff6fab30a907",
    "type": "form_fields",
    "attributes": {
      "team_id": 89,
      "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-04-18T09:46:45.599-07:00",
      "created_at": "2025-04-18T09:46:45.599-07:00"
    },
    "relationships": {
      "options": {
        "data": []
      },
      "positions": {
        "data": [
          {
            "id": "fc0bc5a1-8bc9-48a6-a8b4-b2891e4a90ee",
            "type": "form_field_positions"
          },
          {
            "id": "a091893d-43db-48de-a02a-f4a3d6c42806",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}

Overview

AlertEvents

AlertGroups

AlertRoutingRules

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