Skip to content

SystemStatusIncident

SystemStatusIncident documents an incident affecting the Werk24 platform. It records the incident name, its current status, and a shortlink to the incident page where the full timeline and updates are published. Using this object you can build incident feeds, integrate notifications into your support tooling, or surface active outages directly in your application. The structured format ensures transparency about outages and supports customer success teams when they need to relay the latest status while coordinating remediation work, ultimately improving stakeholder trust.

Bases: BaseModel

Represents an incident currently affecting the platform.

PARAMETER DESCRIPTION
name

TYPE: str

status

TYPE: str

shortlink

TYPE: str | None DEFAULT: None

Source code in werk24/models/v2/status.py
class SystemStatusIncident(BaseModel):
    """Represents an incident currently affecting the platform."""

    name: str
    status: str
    shortlink: Optional[str] = None