Skip to main content
POST
Create status page event

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 a status page incident or maintenance event. The first update must contain component_changes to define affected components; retrospective events require at least 2 updates.

page_id
integer<int64>
required

Status page ID; obtain it from GET /status-page/list.

type
enum<string>
required

Change type: incident unplanned incident, maintenance planned maintenance.

Available options:
incident,
maintenance
title
string
required

Event title, up to 255 characters.

Maximum string length: 255
description
string
required

Event description (Markdown). Must not be empty.

status
enum<string>
required

Initial event status. investigating/identified/monitoring/resolved apply to incidents; scheduled/ongoing/completed apply to maintenances.

Available options:
investigating,
identified,
monitoring,
resolved,
scheduled,
ongoing,
completed
updates
object[]
required

Timeline updates. At least one update is required, and at least one of them must contain component_changes. Immediate events normally pass one update; retrospective events must pass all historical updates.

Minimum array length: 1
start_at_seconds
integer<int64>

Event start time in Unix seconds. The stored start time is always derived from the first update's at_seconds (which defaults to the current time when omitted); for maintenances with auto_update_by_schedule, this value schedules the automatic transition to ongoing.

responders
integer<int64>[]

Member IDs responsible for the event.

linked_changes
string[]

Linked change IDs (related incidents, deployments, etc.).

close_at_seconds
integer<int64>

Event close time in Unix seconds. Must be greater than or equal to the first update's at_seconds. For retrospective events this is the time the event ended; for maintenances with auto_update_by_schedule it schedules the automatic transition to completed and must be within 30 days from now.

notify_subscribers
boolean

Notify subscribers about this event and all its updates.

auto_update_by_schedule
boolean

Maintenance only: automatically advance the status based on the scheduled window.

is_retrospective
boolean

Mark this event as a retrospective (historical) one.

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

Result of creating a status page event.