How to Create a Custom Field#

This topic provides step-by-step instructions for creating a custom field in TheHive.

Administrator access required

Only users with an admin-type profile that has the manageCustomField permission can create, edit, or delete custom fields in TheHive.

Procedure#

As an administrator, go to the Entities management view from the sidebar menu.
Select the Custom fields tab.
Select .
Enter the following information:

Display name

Enter the name users will see when adding this custom field to their cases or alerts.

Technical name

By default, the technical name is automatically generated from the display name, but you can adjust it if needed. Users don't see the technical name when adding a custom field, but it's used when accessing the custom field via the API.

Description

Provide a description to help users understand and use this custom field appropriately.

Group name

Choose an existing group name or type a new one to create a new group.

Data type

Specify the type of data the custom field will contain:
- String: Text input
- Boolean: True/false values
- Integer: Whole numbers
- Float: Decimal numbers
- Date: Specific dates
- URL: Web links
Predefined values

For the string, integer, and float formats, you can define predefined values by entering each value on a separate line. If you choose to do this, users will only be able to select from the predefined values you specify.

Turn on the Mandatory toggle to require users to enter a value in this custom field.
Select Confirm custom field creation.