Skip to main content
POST
Create escalation rule

Restrictions

Usage

  • Rules are evaluated in ascending priority. The first enabled rule whose time_filters and filters match a new incident takes it; later rules are skipped. Omit priority to place the rule after all existing ones.
  • template_id must be an existing notification template, every member in person_ids must exist and every team in team_ids must have members; otherwise InvalidParameter.
  • The new rule is enabled.
  • An unknown channel_id returns InvalidParameter.
  • The caller must also be able to edit the channel: the account owner or an admin, the channel creator, or a member of its managing teams (of its owning team when managing_team_ids is empty). Otherwise the call returns AccessDenied.
  • Every call is recorded in the account audit log.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for creating an escalation rule.

channel_id
integer<int64>
required

Owning channel ID; obtain it from POST /channel/list.

template_id
string
required

Notification template ID (24-character hex); obtain it from POST /template/list. Must exist.

Pattern: ^[0-9a-fA-F]{24}$
rule_name
string
required

Rule name, 1 to 39 characters.

Required string length: 1 - 39
layers
object[]
required

Escalation levels in order; the incident starts at the first level. At least one level is required.

Minimum array length: 1
priority
integer | null

Evaluation order from 0 to 200; lower values are evaluated first. Omit to place the rule after all existing rules (current highest priority + 1).

Required range: 0 <= x <= 200
aggr_window
integer

Delay in seconds, 0–3600, before the first notification for a newly assigned incident; 0 notifies immediately.

Required range: 0 <= x <= 3600
description
string

Rule description, up to 500 characters.

Maximum string length: 500
time_filters
object[]

Recurring time windows during which the rule can match; omit or leave empty to match at any time.

filters
object[][]

Incident conditions (OR of AND groups), matched against the incident the alert was grouped into, not against the alert. Keys: title, description, severity (alias incident_severity, alert_severity), status (alias incident_status, alert_status), dedup_key, integration_id (alias data_source_id), or any labels.<name>. Omit or leave empty to match every incident in the channel.

AND group — all conditions in this array must match.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.