{"openapi":"3.1.0","info":{"title":"POST /api/v1/dashboards/{dashboard_id}/widgets/{widget_id}/alert","version":"1.0.0","description":"Create an alert on a metric widget"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}/alert":{"post":{"tags":["dashboards"],"summary":"Create an alert on a metric widget","description":"Create a threshold alert rule bound to a metric widget. The rule is evaluated against the widget's **stored snapshot** — it never re-executes the widget's source tool, so the alert is exactly as fresh as the dashboard itself. Returns 400 if the widget is not a metric widget or if `value_path` does not resolve to a number in the current snapshot.","operationId":"create_widget_alert","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","title":"Dashboard Id"}},{"name":"widget_id","in":"path","required":true,"schema":{"type":"string","title":"Widget Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWidgetAlertRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WidgetAlertResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing/invalid token or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"create_widget_alert_api_v1_dashboards__dashboard_id__widgets__widget_id__alert_post"}}},"components":{"schemas":{"CreateWidgetAlertRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name"},"threshold_value":{"type":"integer","title":"Threshold Value"},"threshold_direction":{"type":"string","enum":["above","below"],"title":"Threshold Direction"},"value_path":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Value Path"},"channels":{"items":{"type":"string","enum":["inbox","slack","email"]},"type":"array","maxItems":3,"minItems":1,"title":"Channels"},"check_frequency":{"type":"string","enum":["hourly","daily","weekly"],"title":"Check Frequency","default":"daily"},"cooldown_hours":{"type":"integer","maximum":720.0,"minimum":1.0,"title":"Cooldown Hours","default":24},"description":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Description"},"slack_channel":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Slack Channel"}},"additionalProperties":false,"type":"object","required":["threshold_value","threshold_direction"],"title":"CreateWidgetAlertRequest","description":"Body for ``POST /dashboards/{id}/widgets/{widget_id}/alert``.\n\nCreates a ``dashboard_metric`` AlertRule bound to one metric widget. The\npoller reads the widget's *stored snapshot* — it never re-executes the\nwidget's source tool (see ``AlertService._get_dashboard_metric_value``)."},"SuccessEnvelope_WidgetAlertResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/WidgetAlertResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[WidgetAlertResponse]"},"WidgetAlertResponse":{"properties":{"alert_rule_id":{"type":"string","title":"Alert Rule Id"},"dashboard_id":{"type":"string","title":"Dashboard Id"},"widget_id":{"type":"string","title":"Widget Id"},"name":{"type":"string","title":"Name"},"rule_type":{"type":"string","title":"Rule Type"},"threshold_value":{"type":"integer","title":"Threshold Value"},"threshold_direction":{"type":"string","title":"Threshold Direction"},"value_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Path"},"channels":{"items":{"type":"string"},"type":"array","title":"Channels"},"check_frequency":{"type":"string","title":"Check Frequency"},"cooldown_hours":{"type":"integer","title":"Cooldown Hours"},"is_enabled":{"type":"boolean","title":"Is Enabled","default":true}},"additionalProperties":false,"type":"object","required":["alert_rule_id","dashboard_id","widget_id","name","rule_type","threshold_value","threshold_direction","check_frequency","cooldown_hours"],"title":"WidgetAlertResponse","description":"The created alert rule, echoed back for the widget popover."},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}