POST /alert_grouping_settings

Create a new Alert Grouping Setting.

The settings part of Alert Grouper service allows us to create Alert Grouping Settings and configs that are required to be used during grouping of the alerts.

This endpoint will be used to create an instance of AlertGroupingSettings for either one service or many services that are in the alert group setting.

Scoped OAuth requires: services.write

Servers

Request headers

Name Type Required Description
Accept String Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Content-Type String Yes

Possible values:

  • "application/json"

Default value: "application/json"

Request body fields

Name Type Required Description
alert_grouping_setting Object Yes

Defines how alerts will be automatically grouped into incidents based on the configurations defined. Note that the Alert Grouping Setting features are available only on certain plans.

alert_grouping_setting.id String No
alert_grouping_setting.name String No

An optional short-form string that provides succinct information about an AlertGroupingSetting object suitable for primary labeling of the entity. It is not intended to be an identifier.

alert_grouping_setting.description String No

An optional description in string that provides more information about an AlertGroupingSetting object.

alert_grouping_setting.services[] Array No

The array of one or many Services with just ServiceID/name that the AlertGroupingSetting applies to. Type of content_based_intelligent allows for only one service in the array.

alert_grouping_setting.services[].type String No

Possible values:

  • "service_reference"
alert_grouping_setting.config No
alert_grouping_setting.type String No

Possible values:

  • "content_based"
  • "intelligent"
  • "time"
  • "content_based_intelligent"
alert_grouping_setting.created_at String No

The ISO8601 date/time an AlertGroupingSetting got created at.

alert_grouping_setting.updated_at String No

The ISO8601 date/time an AlertGroupingSetting last got updated at.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.