Skip to main content
POST
Create channel

Restrictions

Usage

  • channel_name must be unique within the account; a duplicate returns InvalidParameter.
  • group.method p requires the Standard license or higher and i requires the Pro license. Creating a channel beyond the plan’s channel quota also returns NoLicense.
  • When escalate_rule is set, an enabled escalation rule named Default is created with one level that notifies escalate_rule.target once.
  • Each ID in plugin_ids creates one channel-exclusive integration of that integration type, named after the type.
  • When is_external_report_enabled is true, the response also carries external_report_token.
  • 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 a channel.

team_id
integer<int64>
required

Owning team ID; obtain it from POST /team/list. Required and must exist.

channel_name
string
required

Channel name, 1–59 characters, unique within the account. Must not contain a comma or start or end with whitespace.

Required string length: 1 - 59
managing_team_ids
integer<int64>[]

Additional teams that can manage the channel. Up to 3 entries.

Maximum array length: 3
description
string

Free-form description. Up to 500 characters.

Maximum string length: 500
escalate_rule
object

Creates an enabled escalation rule named Default with a single level that notifies target once. Omit to create the channel without escalation rules.

group
object

Alert grouping configuration. Omit for no grouping (method n).

flapping
object

Flapping detection configuration. Omit to use the defaults.

auto_resolve_timeout
integer<int64>

Auto-resolve timeout in seconds. 0 disables auto-resolve. Max 30 days.

Required range: 0 <= x <= 2592000
auto_resolve_mode
enum<string>

How the auto-resolve timer runs. trigger (default) starts the timer once when the incident is triggered; update restarts it whenever a new alert merges into the incident.

Available options:
trigger,
update
plugin_ids
integer<int64>[]

Integration type IDs (the plugin_id shown on integrations returned by POST /integration/list). For each ID, a channel-exclusive integration of that type is created, named after the type. An unknown ID returns InvalidParameter. At most 50 items per request; split larger sets into several calls. Duplicates are ignored.

Maximum array length: 50
is_private
boolean

When true, the channel is visible only to its managing teams.

disable_outlier_detection
boolean

Disable outlier incident detection.

disable_auto_close
boolean

Disable automatic incident closing.

is_external_report_enabled
boolean

When true, external reporters can file incidents into this channel, and the response carries the generated external_report_token.

event_group
object

Alert event merge configuration. Omit to use the default (merge enabled, 1440-minute window).

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.