POST /incidents/types/{type_id_or_name}/custom_fields
Create a Custom Field for an Incident Type
Custom Fields (CF) are a feature which will allow customers to extend Incidents with their own custom data, to provide additional context and support features such as customized filtering, search and analytics. Custom Fields can be applied to different incident types.
Scoped OAuth requires: custom_fields.write
Servers
- https://api.pagerduty.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
type_id_or_name |
String | Yes |
The ID or name of the Incident Type. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The Default value: "application/vnd.pagerduty+json;version=2" |
Content-Type |
String | Yes |
Possible values:
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
field |
Object | Yes |
Details of the custom field to be created. |
field.default_value |
String | No |
The default value of the custom field. |
field.name |
String | Yes |
The name of the custom field. |
field.data_type |
String | Yes |
The data type of the custom field. |
field.description |
String | No |
The description of the custom field. |
field.field_type |
String | Yes |
The field type of the custom field. Possible values:
|
field.field_options[] |
Array | No |
The options for the custom field. Can only be applied to fields with a |
field.display_name |
String | Yes |
The display name of the Incident Type. |
field.enabled |
Boolean | No |
Whether the custom field is enabled. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.