Skip to main content
POST
Create escalation rule

Restrictions

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

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 (MongoDB ObjectID).

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. At least one level is required.

priority
integer | null

Evaluation priority. Lower runs first.

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

Delay window in seconds. 0 disables delay.

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

Rule description, up to 500 characters.

Maximum string length: 500
time_filters
object[]

Optional recurring time windows during which the rule applies.

filters
object[][]

Incident-level match conditions (OR-of-AND tree): the rule is matched against the incident the alert was grouped into, not against the alert itself. Omit or leave empty to apply the rule to all incidents in the channel.

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
required

Endpoint-specific payload. See each operation's 200 response schema.