FormField

Rootly v3.3.0, May 7 26

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Example Usage

resource "rootly_form_field" "regions_affected" {
  name       = "Regions affected"
  kind       = "custom"
  input_kind = "multi_select"
  shown      = ["web_new_incident_form", "web_update_incident_form"]
  required   = ["web_new_incident_form", "web_update_incident_form"]
}

resource "rootly_form_field_option" "asia" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "Asia"
}

resource "rootly_form_field_option" "europe" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "Europe"
}

resource "rootly_form_field_option" "north_america" {
  form_field_id = rootly_form_field.regions_affected.id
  value         = "North America"
}

Create FormField Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FormField(name: string, args?: FormFieldArgs, opts?: CustomResourceOptions);

@overload
def FormField(resource_name: str,
              args: Optional[FormFieldArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def FormField(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auto_set_by_catalog_property_id: Optional[str] = None,
              default_values: Optional[Sequence[str]] = None,
              description: Optional[str] = None,
              enabled: Optional[bool] = None,
              input_kind: Optional[str] = None,
              kind: Optional[str] = None,
              name: Optional[str] = None,
              requireds: Optional[Sequence[str]] = None,
              show_on_incident_details: Optional[bool] = None,
              showns: Optional[Sequence[str]] = None,
              slug: Optional[str] = None,
              value_kind: Optional[str] = None,
              value_kind_catalog_id: Optional[str] = None)

func NewFormField(ctx *Context, name string, args *FormFieldArgs, opts ...ResourceOption) (*FormField, error)

public FormField(string name, FormFieldArgs? args = null, CustomResourceOptions? opts = null)

public FormField(String name, FormFieldArgs args)
public FormField(String name, FormFieldArgs args, CustomResourceOptions options)

type: rootly:FormField
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args FormFieldArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FormFieldArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FormFieldArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FormFieldArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FormFieldArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var formFieldResource = new Rootly.FormField("formFieldResource", new()
{
    AutoSetByCatalogPropertyId = "string",
    DefaultValues = new[]
    {
        "string",
    },
    Description = "string",
    Enabled = false,
    InputKind = "string",
    Kind = "string",
    Name = "string",
    Requireds = new[]
    {
        "string",
    },
    ShowOnIncidentDetails = false,
    Showns = new[]
    {
        "string",
    },
    Slug = "string",
    ValueKind = "string",
    ValueKindCatalogId = "string",
});

example, err := rootly.NewFormField(ctx, "formFieldResource", &rootly.FormFieldArgs{
	AutoSetByCatalogPropertyId: pulumi.String("string"),
	DefaultValues: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	InputKind:   pulumi.String("string"),
	Kind:        pulumi.String("string"),
	Name:        pulumi.String("string"),
	Requireds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ShowOnIncidentDetails: pulumi.Bool(false),
	Showns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Slug:               pulumi.String("string"),
	ValueKind:          pulumi.String("string"),
	ValueKindCatalogId: pulumi.String("string"),
})

var formFieldResource = new FormField("formFieldResource", FormFieldArgs.builder()
    .autoSetByCatalogPropertyId("string")
    .defaultValues("string")
    .description("string")
    .enabled(false)
    .inputKind("string")
    .kind("string")
    .name("string")
    .requireds("string")
    .showOnIncidentDetails(false)
    .showns("string")
    .slug("string")
    .valueKind("string")
    .valueKindCatalogId("string")
    .build());

form_field_resource = rootly.FormField("formFieldResource",
    auto_set_by_catalog_property_id="string",
    default_values=["string"],
    description="string",
    enabled=False,
    input_kind="string",
    kind="string",
    name="string",
    requireds=["string"],
    show_on_incident_details=False,
    showns=["string"],
    slug="string",
    value_kind="string",
    value_kind_catalog_id="string")

const formFieldResource = new rootly.FormField("formFieldResource", {
    autoSetByCatalogPropertyId: "string",
    defaultValues: ["string"],
    description: "string",
    enabled: false,
    inputKind: "string",
    kind: "string",
    name: "string",
    requireds: ["string"],
    showOnIncidentDetails: false,
    showns: ["string"],
    slug: "string",
    valueKind: "string",
    valueKindCatalogId: "string",
});

type: rootly:FormField
properties:
    autoSetByCatalogPropertyId: string
    defaultValues:
        - string
    description: string
    enabled: false
    inputKind: string
    kind: string
    name: string
    requireds:
        - string
    showOnIncidentDetails: false
    showns:
        - string
    slug: string
    valueKind: string
    valueKindCatalogId: string

FormField Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FormField resource accepts the following input properties:

AutoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
DefaultValues List<string>
Description string: The description of the form field
Enabled bool
InputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
Kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
Name string: The name of the form field
Requireds List<string>
ShowOnIncidentDetails bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
Showns List<string>
Slug string: The slug of the form field
ValueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
ValueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

AutoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
DefaultValues []string
Description string: The description of the form field
Enabled bool
InputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
Kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
Name string: The name of the form field
Requireds []string
ShowOnIncidentDetails bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
Showns []string
Slug string: The slug of the form field
ValueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
ValueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId String: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues List<String>
description String: The description of the form field
enabled Boolean
inputKind String: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind String: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name String: The name of the form field
requireds List<String>
showOnIncidentDetails Boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns List<String>
slug String: The slug of the form field
valueKind String: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId String: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues string[]
description string: The description of the form field
enabled boolean
inputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name string: The name of the form field
requireds string[]
showOnIncidentDetails boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns string[]
slug string: The slug of the form field
valueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

auto_set_by_catalog_property_id str: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
default_values Sequence[str]
description str: The description of the form field
enabled bool
input_kind str: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind str: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name str: The name of the form field
requireds Sequence[str]
show_on_incident_details bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns Sequence[str]
slug str: The slug of the form field
value_kind str: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
value_kind_catalog_id str: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId String: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues List<String>
description String: The description of the form field
enabled Boolean
inputKind String: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind String: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name String: The name of the form field
requireds List<String>
showOnIncidentDetails Boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns List<String>
slug String: The slug of the form field
valueKind String: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId String: The ID of the catalog used when valueKind is catalogEntity

Outputs

All input properties are implicitly available as output properties. Additionally, the FormField resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing FormField Resource

Get an existing FormField resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FormFieldState, opts?: CustomResourceOptions): FormField

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_set_by_catalog_property_id: Optional[str] = None,
        default_values: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        input_kind: Optional[str] = None,
        kind: Optional[str] = None,
        name: Optional[str] = None,
        requireds: Optional[Sequence[str]] = None,
        show_on_incident_details: Optional[bool] = None,
        showns: Optional[Sequence[str]] = None,
        slug: Optional[str] = None,
        value_kind: Optional[str] = None,
        value_kind_catalog_id: Optional[str] = None) -> FormField

func GetFormField(ctx *Context, name string, id IDInput, state *FormFieldState, opts ...ResourceOption) (*FormField, error)

public static FormField Get(string name, Input<string> id, FormFieldState? state, CustomResourceOptions? opts = null)

public static FormField get(String name, Output<String> id, FormFieldState state, CustomResourceOptions options)

resources:  _:    type: rootly:FormField    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
DefaultValues List<string>
Description string: The description of the form field
Enabled bool
InputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
Kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
Name string: The name of the form field
Requireds List<string>
ShowOnIncidentDetails bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
Showns List<string>
Slug string: The slug of the form field
ValueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
ValueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

AutoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
DefaultValues []string
Description string: The description of the form field
Enabled bool
InputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
Kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
Name string: The name of the form field
Requireds []string
ShowOnIncidentDetails bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
Showns []string
Slug string: The slug of the form field
ValueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
ValueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId String: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues List<String>
description String: The description of the form field
enabled Boolean
inputKind String: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind String: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name String: The name of the form field
requireds List<String>
showOnIncidentDetails Boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns List<String>
slug String: The slug of the form field
valueKind String: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId String: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId string: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues string[]
description string: The description of the form field
enabled boolean
inputKind string: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind string: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name string: The name of the form field
requireds string[]
showOnIncidentDetails boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns string[]
slug string: The slug of the form field
valueKind string: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId string: The ID of the catalog used when valueKind is catalogEntity

auto_set_by_catalog_property_id str: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
default_values Sequence[str]
description str: The description of the form field
enabled bool
input_kind str: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind str: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name str: The name of the form field
requireds Sequence[str]
show_on_incident_details bool: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns Sequence[str]
slug str: The slug of the form field
value_kind str: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
value_kind_catalog_id str: The ID of the catalog used when valueKind is catalogEntity

autoSetByCatalogPropertyId String: Catalog property ID to auto-set this form field. Only reference-kind catalog properties are supported.
defaultValues List<String>
description String: The description of the form field
enabled Boolean
inputKind String: The input kind of the form field. Value must be one of text, textarea, select, multiSelect, date, datetime, number, checkbox, tags, richText.
kind String: The kind of the form field. Value must be one of custom, title, summary, mitigationMessage, resolutionMessage, severity, environments, types, services, causes, functionalities, teams, visibility, markAsTest, markAsBackfilled, labels, notifyEmails, triggerManualWorkflows, showOngoingIncidents, attachAlerts, markAsInTriage, inTriageAt, startedAt, detectedAt, acknowledgedAt, mitigatedAt, resolvedAt, closedAt, customSubStatus, manualStartingDatetimeField.
name String: The name of the form field
requireds List<String>
showOnIncidentDetails Boolean: Whether the form field is shown on the incident details panel. Value must be one of true or false
showns List<String>
slug String: The slug of the form field
valueKind String: The value kind of the form field. Value must be one of inherit, group, service, functionality, user, catalogEntity, environment, cause, incidentType.
valueKindCatalogId String: The ID of the catalog used when valueKind is catalogEntity

Import

rootly.FormField can be imported using the import command.

$ pulumi import rootly:index/formField:FormField primary a816421c-6ceb-481a-87c4-585e47451f24

Or using an import block.

Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

HCL can be generated from the import block using the -generate-config-out flag.

pulumi preview -generate-config-out=generated.tf

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: rootly rootlyhq/pulumi-rootly
License: Apache-2.0
Notes: This Pulumi package is based on the rootly Terraform Provider.

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

rootly.FormField

On this page

On this page

Example Usage

Create FormField Resource

Constructor syntax

Parameters

Constructor example

FormField Resource Properties

Inputs

Outputs

Look up Existing FormField Resource

Import

Package Details

On this page

On this page