Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.incident.io/llms.txt

Use this file to discover all available pages before exploring further.

Manage custom fields. Custom fields are used to attach metadata to incidents, which you can use when searching for incidents in the dashboard, triggering workflows, building announcement rules or for your own data needs. Each field has a type:
  • Single-select, single value selected from a predefined list of options (e.g. Detection Method)
  • Multi-select, as above but you can pick more than one option (e.g. Affected Teams)
  • Text, freeform text field (e.g. Customer ID)
  • Link, link URL that is synced to Slack bookmarks on the incident channel (e.g. External Status Page)
  • Number, integer or fractional numbers (e.g. # Customers Affected)
We may add more custom field types in the future - we’d love to hear any other types you’d like to use!

​
The custom field object

​
created_at
string<date-time>
required

When the action was created

Example:

"2021-08-17T13:28:57.801578Z"

​
description
string
required

Description of the custom field

Example:

"Which team is impacted by this issue"

​
field_type
enum<string>
required

Type of custom field

Available options:
single_select,
multi_select,
text,
link,
numeric
Example:

"single_select"

​
id
string
required

Unique identifier for the custom field

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
name
string
required

Human readable name for the custom field

Maximum string length: 50
Example:

"Affected Team"

​
updated_at
string<date-time>
required

When the action was last updated

Example:

"2021-08-17T13:28:57.801578Z"

​
catalog_type_id
string

For catalog fields, the ID of the associated catalog type

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
filter_by
object
Example:
{
  "catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  "custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
}
​
group_by_catalog_attribute_id
string

For catalog fields, the ID of the attribute used to group catalog entries (if applicable)

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
helptext_catalog_attribute_id
string

Which catalog attribute provides helptext for the options

Example:

"01H2FW182TAH0NHEVBY34SCAK0"