> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Fields

> Add custom metadata to incidents to record specific business information

<Tip>**Plan requirement**: This feature requires an On-call Standard or higher subscription. [Learn more](https://flashcat.cloud/flashduty/price/)</Tip>

Custom fields extend incident description information. Flashduty On-call supports integrating most common alert systems, displaying pushed content in Labels. But you may need to record additional information, such as manually marking whether an incident is a false alarm. Custom fields are designed for this purpose.

## Use Cases

<CardGroup cols={3}>
  <Card title="Flexible Definition" icon="sliders">
    Create multiple custom fields, define names, types, options, and default values. Supports text, single-select, multi-select, checkbox types
  </Card>

  <Card title="Information Association" icon="link">
    Associate incidents with business data like affected systems, geographic location, related customers, whether it's a false alarm, etc.
  </Card>

  <Card title="Filter and Categorize" icon="filter">
    Filter and categorize incident views by custom fields, create common filters to efficiently organize and handle incidents
  </Card>
</CardGroup>

### Field Definition Example

<Frame caption="Custom Fields List">
  <img src="https://download.flashcat.cloud/flashduty/doc/en/fd/field-1.png" alt="Custom Fields List" />
</Frame>

### Incident Information Association

<Frame caption="Set Custom Fields in Incident Details">
  <img src="https://download.flashcat.cloud/flashduty/doc/en/fd/field-2.png" alt="Set Custom Fields" />
</Frame>

### Filter View by Field

<Frame caption="Filter Incidents by Custom Field">
  <img src="https://download.flashcat.cloud/flashduty/doc/en/fd/field-3.png" alt="Filter by Field" />
</Frame>

## Configuring Fields

### Creating Fields

<Note>
  An account supports creating up to **15** custom fields.
</Note>

<Steps>
  <Step title="Enter Configuration Page">
    Go to Console **Incident Management** → **Custom Fields**
  </Step>

  <Step title="Create Field">
    Click **Create Custom Field**, enter the following information:

    | Configuration         | Description                                                    | Constraints                                                                                                                    |
    | :-------------------- | :------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- |
    | **Field Name**        | Identifies the field in API, cannot be modified after creation | 1-40 characters; letters, digits, and underscores only, and cannot start with a digit (regex: `^[a-zA-Z_][a-zA-Z0-9_]{0,39}$`) |
    | **Display Name**      | Shown on incident details page, can be modified after creation | 1-40 characters                                                                                                                |
    | **Field Description** | Helps incident handlers understand and use this field          | Up to 200 characters, optional                                                                                                 |
  </Step>

  <Step title="Select Field Type">
    | Type              | Description                                                                 |
    | :---------------- | :-------------------------------------------------------------------------- |
    | **Text**          | Plain text input, max 3,000 characters                                      |
    | **Single-select** | Dropdown with single selection, max 20 options, each up to 200 characters   |
    | **Multi-select**  | Dropdown with multiple selection, max 20 options, each up to 200 characters |
    | **Checkbox**      | Checkbox toggle                                                             |
  </Step>

  <Step title="Complete Creation">
    Set options and default values as needed, click **Submit** to finish.

    <Note>
      For single-select and multi-select fields, the **default value** must be one of the options currently defined on the field. If you delete or modify an option, update the default value accordingly — otherwise the field cannot be saved.
    </Note>
  </Step>
</Steps>

<Tip>
  If a field has a default value set, the system automatically writes that field when incidents are created. Note that field configurations only affect new incidents, not existing ones.
</Tip>

### Updating Fields

Only the following can be updated:

* Display name
* Field description
* Field options (single-select and multi-select types only)
* Default value

<Note>
  Field updates only affect new incidents, not existing ones.
</Note>

### Deleting Fields

You can initiate deletion from the console at any time.

<Warning>
  Deletion is a time-consuming operation. The system scans historical incidents and asynchronously deletes field associations. You cannot create a field with the same name until deletion is complete.
</Warning>

## FAQ

<AccordionGroup>
  <Accordion title="Why can't I search incidents by my created field?">
    Please confirm whether the field type you want to search is **Text** type. To ensure system stability, searching text type fields is currently not supported.

    <Tip>
      If you need to filter incidents by field value, we recommend using **Single-select** or **Multi-select** types.
    </Tip>
  </Accordion>
</AccordionGroup>

## Related Topics

<CardGroup cols={2}>
  <Card title="Search and View Incidents" icon="magnifying-glass" href="/en/on-call/incident/search-view-incident">
    Learn about incident filtering and viewing features
  </Card>

  <Card title="Handle and Update Incidents" icon="pen-to-square" href="/en/on-call/incident/handle-update-incident">
    Learn about incident handling workflow
  </Card>
</CardGroup>