Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Zenduty Provider
  4. API Docs
  5. IncidentCustomField
Viewing docs for zenduty 2.2.0
published on Friday, Oct 30, 2026 by zenduty
Schema (JSON)
zenduty/terraform-provider-zenduty

zenduty.IncidentCustomField

zenduty
Viewing docs for zenduty 2.2.0
published on Friday, Oct 30, 2026 by zenduty
Schema (JSON)
zenduty/terraform-provider-zenduty

    zenduty.IncidentCustomField defines a custom field that incident types can place on their incident form (see zenduty.IncidentType). An account can have up to 20 custom fields.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as zenduty from "@pulumi/zenduty";

const region = new zenduty.IncidentCustomField("region", {
    fieldType: 3,
    properties: JSON.stringify({
        type: "string",
        title: "Region",
        "enum": [
            "eu-west",
            "eu-central",
            "us-east",
        ],
    }),
});
const ticket = new zenduty.IncidentCustomField("ticket", {
    fieldType: 5,
    properties: JSON.stringify({
        type: "string",
        title: "Ticket",
    }),
});

    import pulumi
import json
import pulumi_zenduty as zenduty

region = zenduty.IncidentCustomField("region",
    field_type=3,
    properties=json.dumps({
        "type": "string",
        "title": "Region",
        "enum": [
            "eu-west",
            "eu-central",
            "us-east",
        ],
    }))
ticket = zenduty.IncidentCustomField("ticket",
    field_type=5,
    properties=json.dumps({
        "type": "string",
        "title": "Ticket",
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/zenduty/v2/zenduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"type":  "string",
			"title": "Region",
			"enum": []string{
				"eu-west",
				"eu-central",
				"us-east",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = zenduty.NewIncidentCustomField(ctx, "region", &zenduty.IncidentCustomFieldArgs{
			FieldType:  pulumi.Float64(3),
			Properties: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"type":  "string",
			"title": "Ticket",
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = zenduty.NewIncidentCustomField(ctx, "ticket", &zenduty.IncidentCustomFieldArgs{
			FieldType:  pulumi.Float64(5),
			Properties: pulumi.String(json1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Zenduty = Pulumi.Zenduty;

return await Deployment.RunAsync(() => 
{
    var region = new Zenduty.IncidentCustomField("region", new()
    {
        FieldType = 3,
        Properties = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["type"] = "string",
            ["title"] = "Region",
            ["enum"] = new[]
            {
                "eu-west",
                "eu-central",
                "us-east",
            },
        }),
    });

    var ticket = new Zenduty.IncidentCustomField("ticket", new()
    {
        FieldType = 5,
        Properties = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["type"] = "string",
            ["title"] = "Ticket",
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zenduty.IncidentCustomField;
import com.pulumi.zenduty.IncidentCustomFieldArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var region = new IncidentCustomField("region", IncidentCustomFieldArgs.builder()
            .fieldType(3.0)
            .properties(serializeJson(
                jsonObject(
                    jsonProperty("type", "string"),
                    jsonProperty("title", "Region"),
                    jsonProperty("enum", jsonArray(
                        "eu-west", 
                        "eu-central", 
                        "us-east"
                    ))
                )))
            .build());

        var ticket = new IncidentCustomField("ticket", IncidentCustomFieldArgs.builder()
            .fieldType(5.0)
            .properties(serializeJson(
                jsonObject(
                    jsonProperty("type", "string"),
                    jsonProperty("title", "Ticket")
                )))
            .build());

    }
}

    resources:
  region:
    type: zenduty:IncidentCustomField
    properties:
      fieldType: 3 # select
      properties:
        fn::toJSON:
          type: string
          title: Region
          enum:
            - eu-west
            - eu-central
            - us-east
  ticket:
    type: zenduty:IncidentCustomField
    properties:
      fieldType: 5 # url
      properties:
        fn::toJSON:
          type: string
          title: Ticket

    Example coming soon!

    Create IncidentCustomField Resource

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

    Constructor syntax

    new IncidentCustomField(name: string, args: IncidentCustomFieldArgs, opts?: CustomResourceOptions);
    @overload
def IncidentCustomField(resource_name: str,
                        args: IncidentCustomFieldArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def IncidentCustomField(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        field_type: Optional[float] = None,
                        properties: Optional[str] = None,
                        incident_custom_field_id: Optional[str] = None)
    func NewIncidentCustomField(ctx *Context, name string, args IncidentCustomFieldArgs, opts ...ResourceOption) (*IncidentCustomField, error)
    public IncidentCustomField(string name, IncidentCustomFieldArgs args, CustomResourceOptions? opts = null)
    public IncidentCustomField(String name, IncidentCustomFieldArgs args)
public IncidentCustomField(String name, IncidentCustomFieldArgs args, CustomResourceOptions options)

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


    resource "zenduty_incident_custom_field" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IncidentCustomFieldArgs
    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 IncidentCustomFieldArgs
    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 IncidentCustomFieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IncidentCustomFieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IncidentCustomFieldArgs
    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 incidentCustomFieldResource = new Zenduty.IncidentCustomField("incidentCustomFieldResource", new()
{
    FieldType = 0.0,
    Properties = "string",
    IncidentCustomFieldId = "string",
});

    example, err := zenduty.NewIncidentCustomField(ctx, "incidentCustomFieldResource", &zenduty.IncidentCustomFieldArgs{
	FieldType:             pulumi.Float64(0),
	Properties:            pulumi.String("string"),
	IncidentCustomFieldId: pulumi.String("string"),
})

    resource "zenduty_incident_custom_field" "incidentCustomFieldResource" {
  lifecycle {
    create_before_destroy = true
  }
  field_type               = 0
  properties               = "string"
  incident_custom_field_id = "string"
}

    var incidentCustomFieldResource = new IncidentCustomField("incidentCustomFieldResource", IncidentCustomFieldArgs.builder()
    .fieldType(0.0)
    .properties("string")
    .incidentCustomFieldId("string")
    .build());

    incident_custom_field_resource = zenduty.IncidentCustomField("incidentCustomFieldResource",
    field_type=float(0),
    properties="string",
    incident_custom_field_id="string")

    const incidentCustomFieldResource = new zenduty.IncidentCustomField("incidentCustomFieldResource", {
    fieldType: 0,
    properties: "string",
    incidentCustomFieldId: "string",
});

    type: zenduty:IncidentCustomField
properties:
    fieldType: 0
    incidentCustomFieldId: string
    properties: string

    IncidentCustomField 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 IncidentCustomField resource accepts the following input properties:

    FieldType double
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    Properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    IncidentCustomFieldId string
    The unique_id of the custom field.
    FieldType float64
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    Properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    IncidentCustomFieldId string
    The unique_id of the custom field.
    field_type number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    incident_custom_field_id string
    The unique_id of the custom field.
    fieldType Double
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    properties String
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    incidentCustomFieldId String
    The unique_id of the custom field.
    fieldType number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    incidentCustomFieldId string
    The unique_id of the custom field.
    field_type float
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    properties str
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    incident_custom_field_id str
    The unique_id of the custom field.
    fieldType Number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    properties String
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    incidentCustomFieldId String
    The unique_id of the custom field.

    Outputs

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

    FieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    Id string
    The provider-assigned unique ID for this managed resource.
    FieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    Id string
    The provider-assigned unique ID for this managed resource.
    field_key string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    id string
    The provider-assigned unique ID for this managed resource.
    fieldKey String
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    id String
    The provider-assigned unique ID for this managed resource.
    fieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    id string
    The provider-assigned unique ID for this managed resource.
    field_key str
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    id str
    The provider-assigned unique ID for this managed resource.
    fieldKey String
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IncidentCustomField Resource

    Get an existing IncidentCustomField 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?: IncidentCustomFieldState, opts?: CustomResourceOptions): IncidentCustomField
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        field_key: Optional[str] = None,
        field_type: Optional[float] = None,
        incident_custom_field_id: Optional[str] = None,
        properties: Optional[str] = None) -> IncidentCustomField
    func GetIncidentCustomField(ctx *Context, name string, id IDInput, state *IncidentCustomFieldState, opts ...ResourceOption) (*IncidentCustomField, error)
    public static IncidentCustomField Get(string name, Input<string> id, IncidentCustomFieldState? state, CustomResourceOptions? opts = null)
    public static IncidentCustomField get(String name, Output<String> id, IncidentCustomFieldState state, CustomResourceOptions options)
    resources:  _:    type: zenduty:IncidentCustomField    get:      id: ${id}
    import {
  to = zenduty_incident_custom_field.example
  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:
    FieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    FieldType double
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    IncidentCustomFieldId string
    The unique_id of the custom field.
    Properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    FieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    FieldType float64
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    IncidentCustomFieldId string
    The unique_id of the custom field.
    Properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    field_key string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    field_type number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    incident_custom_field_id string
    The unique_id of the custom field.
    properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    fieldKey String
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    fieldType Double
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    incidentCustomFieldId String
    The unique_id of the custom field.
    properties String
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    fieldKey string
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    fieldType number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    incidentCustomFieldId string
    The unique_id of the custom field.
    properties string
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    field_key str
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    field_type float
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    incident_custom_field_id str
    The unique_id of the custom field.
    properties str
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.
    fieldKey String
    Backend-generated key (custom_field_<n>) under which the field's value appears in incident payloads.
    fieldType Number
    0 string, 2 integer, 3 select, 4 multiselect, 5 url.
    incidentCustomFieldId String
    The unique_id of the custom field.
    properties String
    The field's JSON Schema property descriptor, as JSON. title is required (unique within the account, at most 256 characters) and type must match the field type: string for string, select and url, integer for integer, array for multiselect. A select needs a non-empty enum; a multiselect needs items.enum. These rules are checked at plan time.

    Import

    hcl

    resource “zenduty_incident_custom_field” “region” {

    }

    $ pulumi import zenduty:index/incidentCustomField:IncidentCustomField region custom_field_id`

    $ terraform state show zenduty_incident_custom_field.region

    * copy the output data and paste inside zenduty_incident_custom_field.region resource block and remove the id and field_key attributes

    $ pulumi preview to verify the import

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

    Package Details

    Repository
    zenduty zenduty/terraform-provider-zenduty
    License
    Notes
    This Pulumi package is based on the zenduty Terraform Provider.
    zenduty
    Viewing docs for zenduty 2.2.0
    published on Friday, Oct 30, 2026 by zenduty
    Schema (JSON)
    zenduty/terraform-provider-zenduty

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial