Custom Fields V1

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 V1Deprecated

List all custom fields for an organisation.

Responses
200

OK response.

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


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


 
field_type
required
string
Type of custom field


 Enum: "single_select" "multi_select" "text" "link" "numeric"  
name
required
string  <= 50 characters 
Human readable name for the custom field


 
required
string
When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].


 Enum: "never" "before_closure" "always"  
required_v2
string
When this custom field must be set during the incident lifecycle.


 Enum: "never" "before_resolution" "always"  
show_before_closure
required
boolean
Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.


 
show_before_creation
required
boolean
Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.


 
show_before_update
required
boolean
Whether a custom field should be shown in the incident update modal.


 
show_in_announcement_post
boolean
Whether a custom field should be shown in the list of fields as part of the announcement post when set.


 
Responses 
201
Created response.


post/v1/custom_fields
Request samples 
application/json
{
  • "description": "Which team is impacted by this issue",
  • "field_type": "single_select",
  • "name": "Affected Team",
  • "required": "never",
  • "required_v2": "never",
  • "show_before_closure": true,
  • "show_before_creation": true,
  • "show_before_update": true,
  • "show_in_announcement_post": true
}
Response samples 
application/json
{
  • "custom_field": {
    }
}
Delete Custom Fields V1Deprecated
Delete a custom field


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


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
204
No Content response.


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


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


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
200
OK response.


get/v1/custom_fields/{id}
Request samples 
Response samples 
application/json
{
  • "custom_field": {
    }
}
Update Custom Fields V1Deprecated
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


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


 
required
string
When this custom field must be set during the incident lifecycle. [DEPRECATED: please use required_v2 instead].


 Enum: "never" "before_closure" "always"  
required_v2
string
When this custom field must be set during the incident lifecycle.


 Enum: "never" "before_resolution" "always"  
show_before_closure
required
boolean
Whether a custom field should be shown in the incident resolve modal. If this custom field is required before resolution, but no value has been set for it, the field will be shown in the resolve modal whatever the value of this setting.


 
show_before_creation
required
boolean
Whether a custom field should be shown in the incident creation modal. This must be true if the field is always required.


 
show_before_update
required
boolean
Whether a custom field should be shown in the incident update modal.


 
show_in_announcement_post
boolean
Whether a custom field should be shown in the list of fields as part of the announcement post when set.


 
Responses 
200
OK response.


put/v1/custom_fields/{id}
Request samples 
application/json
{
  • "description": "Which team is impacted by this issue",
  • "name": "Affected Team",
  • "required": "never",
  • "required_v2": "never",
  • "show_before_closure": true,
  • "show_before_creation": true,
  • "show_before_update": true,
  • "show_in_announcement_post": true
}
Response samples 
application/json
{
  • "custom_field": {
    }
}
➔ Next to Custom Fields V2