Custom Fields V2

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!

List Custom Fields V2

List all custom fields for an organisation.

Responses
200

OK response.

get/v2/custom_fields
Request samples 
Response samples 
application/json
{
  • "custom_fields": [
    ]
}
Create Custom Fields V2
Create a new custom field


Request 
Request Body schema: application/json
required
catalog_type_id
string
For catalog fields, the ID of the associated catalog type


 
description
required
string
Description of the custom field


 
field_type
required
string
Type of custom field


 Enum: "single_select" "multi_select" "text" "link" "numeric"  
object (CustomFieldFilterByOptionsV2) 
 
group_by_catalog_attribute_id
string
For catalog fields, the ID of the attribute used to group catalog entries (if applicable)


 
helptext_catalog_attribute_id
string
Which catalog attribute provides helptext for the options


 
name
required
string  <= 50 characters 
Human readable name for the custom field


 
Responses 
201
Created response.


post/v2/custom_fields
Request samples 
application/json
{
  • "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  • "description": "Which team is impacted by this issue",
  • "field_type": "single_select",
  • "filter_by": {
    },
  • "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  • "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  • "name": "Affected Team"
}
Response samples 
application/json
{
  • "custom_field": {
    }
}
Delete Custom Fields V2
Delete a custom field


Request 
path Parameters
id
required
string
Unique identifier for the custom field


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
204
No Content response.


delete/v2/custom_fields/{id}
Request samples 
Show Custom Fields V2
Get a single custom field.


Request 
path Parameters
id
required
string
Unique identifier for the custom field


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
200
OK response.


get/v2/custom_fields/{id}
Request samples 
Response samples 
application/json
{
  • "custom_field": {
    }
}
Update Custom Fields V2
Update the details of a custom field


Request 
path Parameters
id
required
string
Unique identifier for the custom field


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Request Body schema: application/json
required
description
required
string
Description of the custom field


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


 
helptext_catalog_attribute_id
string
Which catalog attribute provides helptext for the options


 
name
required
string  <= 50 characters 
Human readable name for the custom field


 
Responses 
200
OK response.


put/v2/custom_fields/{id}
Request samples 
application/json
{
  • "description": "Which team is impacted by this issue",
  • "filter_by": {
    },
  • "group_by_catalog_attribute_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  • "helptext_catalog_attribute_id": "01H2FW182TAH0NHEVBY34SCAK0",
  • "name": "Affected Team"
}
Response samples 
application/json
{
  • "custom_field": {
    }
}
➔ Next to Escalations V2