> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # Create channel > Create a new channel for incident management. ## Restrictions | Aspect | Value | | ----------- | ------------------------------------------------------------- | | Rate limits | **1,000 requests/minute**; **50 requests/second** per account | | Permissions | **Channels Manage** (`on-call`) | ## OpenAPI ````yaml /api-reference/on-call.openapi.en.json post /channel/create openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: On-call/Incidents description: '' - name: On-call/Channels description: '' - name: On-call/Alerts description: >- Search, inspect, and act on alerts. Manage card views and alert processing pipelines. - name: On-call/Integrations description: '' - name: On-call/IM integrations description: IM integration queries, such as which integrations have war room enabled. - name: On-call/Schedules description: '' - name: On-call/Calendars description: '' - name: On-call/Notification templates description: '' - name: On-call/Alert enrichment description: Custom fields, enrichment rules, and data mapping (schema, data, API). - name: On-call/Analytics description: '' - name: On-call/Status pages description: '' - name: On-call/Changes description: '' paths: /channel/create: post: tags: - On-call/Channels summary: Create channel description: Create a new channel for incident management. operationId: channelCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateChannelRequest' example: team_id: 3521074710131 channel_name: Production Alerts description: Handles all production environment alerts group: method: p time_window: 10 window_type: tumbling auto_resolve_timeout: 86400 auto_resolve_mode: trigger responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/ChannelCreateResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: channel_id: 6294542005131 channel_name: API Test Channel '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: CreateChannelRequest: type: object description: Parameters for creating a channel. required: - team_id - channel_name properties: team_id: type: integer format: int64 description: Owning team ID. managing_team_ids: type: array items: type: integer format: int64 maxItems: 3 description: Additional teams that can manage the channel. Up to 3 entries. channel_name: type: string minLength: 1 maxLength: 59 description: Channel name. 1 to 59 characters. description: type: string maxLength: 500 description: Free-form description. Up to 500 characters. escalate_rule: type: object description: >- Default escalation rule applied to the channel. Omit to skip default escalation. required: - template_id - target properties: aggr_window: type: integer minimum: 0 maximum: 3600 description: Delay window in seconds. 0 disables delay. template_id: type: string pattern: ^[0-9a-fA-F]{24}$ description: Notification template ID (MongoDB ObjectID). target: type: object description: >- Notification target. At least one of `person_ids`, `team_ids`, `schedule_to_role_ids`, or `emails` must be set, together with either `by` or `webhooks`. properties: person_ids: type: array items: type: integer format: int64 description: Member IDs to notify directly. team_ids: type: array items: type: integer format: int64 description: Team IDs to notify. schedule_to_role_ids: type: object additionalProperties: type: array items: type: integer format: int64 description: >- Map of schedule ID to the role IDs on that schedule to notify. emails: type: array items: type: string format: email description: Email addresses to notify (push-only scenarios). by: type: object description: >- Per-severity personal notification channels. Required unless `webhooks` is provided. properties: follow_preference: type: boolean description: >- When true, use each responder's personal preference instead of the lists below. critical: type: array items: type: string description: >- Channels for Critical events (e.g. `voice`, `sms`, `email`, `feishu`). warning: type: array items: type: string description: Channels for Warning events. info: type: array items: type: string description: Channels for Info events. webhooks: type: array description: >- Group chat / webhook targets. Required unless `by` is provided. items: type: object required: - type - settings properties: type: type: string description: >- Webhook type (e.g. `feishu`, `dingtalk_app`, `wecom_app`, `slack`, `teams`, `custom`). settings: type: object additionalProperties: true description: Type-specific settings (chat IDs, URLs, etc.). group: type: object description: Alert grouping configuration. required: - method properties: method: type: string enum: - i - p - 'n' description: 'Grouping method: `i` intelligent, `p` pattern, `n` none.' equals: type: array items: type: array items: type: string maxItems: 5 description: Groups of label keys whose equality defines a bucket. cases: type: array maxItems: 100 description: Per-filter grouping overrides. items: type: object all_equals_required: type: boolean description: When true, all listed keys must be present for grouping. time_window: type: integer minimum: 0 description: Grouping time window in seconds. window_type: type: string enum: - tumbling - sliding description: Window type. Defaults to `tumbling`. storm_threshold: type: integer minimum: 0 maximum: 10000 description: Alert storm threshold. storm_thresholds: type: array items: type: integer maxItems: 5 description: Multi-level storm thresholds. i_keys: type: array items: type: string maxItems: 10 description: Label keys used for intelligent grouping embeddings. i_score_threshold: type: number format: float minimum: 0.5 maximum: 1 description: Intelligent grouping similarity threshold. flapping: type: object description: Flapping detection configuration. properties: is_disabled: type: boolean description: Disable flapping detection. max_changes: type: integer minimum: 2 maximum: 100 description: Max state changes allowed within `in_mins`. in_mins: type: integer minimum: 1 maximum: 1440 description: Observation window in minutes. mute_mins: type: integer minimum: 0 maximum: 1440 description: Mute duration in minutes after flapping is detected. auto_resolve_timeout: type: integer format: int64 minimum: 0 maximum: 2592000 description: >- Auto-resolve timeout in seconds. 0 disables auto-resolve. Max 30 days. auto_resolve_mode: type: string enum: - trigger - update description: Auto-resolve timer reset mode. plugin_ids: type: array items: type: integer format: int64 description: IDs of plugins (integrations) subscribed to this channel. is_private: type: boolean description: When true, the channel is visible only to its managing teams. disable_outlier_detection: type: boolean description: Disable outlier incident detection. disable_auto_close: type: boolean description: Disable automatic incident closing. is_external_report_enabled: type: boolean description: Allow external reporters to file incidents into this channel. SuccessEnvelope: type: object description: >- 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`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data ChannelCreateResponse: type: object required: - channel_id - channel_name properties: channel_id: type: integer format: int64 description: Newly created channel ID. channel_name: type: string description: Channel name echoed back from the request. external_report_token: type: string description: >- External report token. Emitted only when external reporting is enabled. ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. required: - code - message ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- 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. ````