Custom Fields
API endpoints for custom fields
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)
The custom field object
When the action was created
Example:
"2021-08-17T13:28:57.801578Z"
Description of the custom field
Example:
"Which team is impacted by this issue"
Type of custom field
Available options:
single_select, multi_select, text, link, numeric Example:
"single_select"
Unique identifier for the custom field
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Human readable name for the custom field
Maximum string length:
50Example:
"Affected Team"
When the action was last updated
Example:
"2021-08-17T13:28:57.801578Z"
For catalog fields, the ID of the associated catalog type
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Show child attributes
Show child attributes
Example:
{
"catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
"custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
}
Show child attributes
Show child attributes
Example:
{
"catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
"values": [
"01H2FW182TAH0NHEVBY34SCAK0",
"01H2FW182TAH0NHEVBY34SCAK1"
]
}
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Which catalog attribute provides helptext for the options
Example:
"01H2FW182TAH0NHEVBY34SCAK0"
Was this page helpful?
{
"created_at": "2021-08-17T13:28:57.801578Z",
"description": "Which team is impacted by this issue",
"field_type": "single_select",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Affected Team",
"updated_at": "2021-08-17T13:28:57.801578Z",
"catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"filter_by": {
"catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
"custom_field_id": "01H2FW182TAH0NHEVBY34SCAK0"
},
"fixed_filter": {
"catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
"values": [
"01H2FW182TAH0NHEVBY34SCAK0",
"01H2FW182TAH0NHEVBY34SCAK1"
]
},
"group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0"
}