DashboardSupportWelcome

👤 USER DOCS

Getting Started

Daily Operations

Shift Workspace & TasksPre-Shift SetupLine-Up CardsShift ReportsForms

Staff & Locations

Staff SchedulingManaging Locations

Oversight

Manager ReportsAnalyticsPre-Shift & Compliance

Incidents & Feedback

Incident ReportingAnonymous FeedbackMessages & Announcements

AI & Settings

AI ChatgearApp Settings

Administration

Dashboard & OnboardingAdmin

⚙️ DEVELOPER DOCS

Getting Started

Getting StartedDevelopmentDeployment Guide

Architecture

Architecture OverviewData FlowArchitecture Decision Records

Core Domain

Core DomainDatabase ReferenceLocations DomainAuth & RBACScheduling DomainReports DomainIncidents DomainNotifications DomainAudit Log & OptimizationDesign Audit Findings

Frontend

Frontend ArchitectureFormsLoading SkeletonsComponentsPWA & NotificationsimageScreenshots

API Reference

API Reference

Endpoints

POS Sales APIOptimization Data APISchedule Shifts APIEmployee Export APIReports APIIncidents APIAI Chat APIPush Notifications APIWebhooks APICron API

Contributing

ContributingcodeCode Examples

Security

Security & Compliance
Danvas IconDanvas
Danvas IconDanvas

Incidents API

Endpoints for reporting and managing operational incidents

Overview

The Incidents API provides programmatic access to the incident reporting system. It supports creating new incidents, adding comments, changing statuses, and escalating high-priority issues.

Endpoints

Report Incident

POST /api/incidents

Request Body

  • locationId: string (UUID, required)
  • type: "Injury" | "Near Miss" | "Spill / Slip Hazard" | "Complaint" | "Maintenance" | "Stockout" (required)
  • severity: "low" | "medium" | "high" | "critical" (required)
  • notes: string (incident description, required, max 5000 characters)
  • mediaUrls: array of string (optional, Vercel Blob URLs)
  • contactMode: "none" | "existing" | "new" (optional)
  • contactId: string (optional, UUID of existing contact)
  • contactName: string (optional, name for new contact)
  • contactPhone: string (optional, phone number for new contact)
  • contactEmail: string (optional, email address for new contact)
  • contactNotes: string (optional, notes for new contact)

Add Comment

POST /api/incidents/:id/comments

Request Body

  • content: string

Update Status

PATCH /api/incidents/:id

Request Body

  • status: "reported" | "investigating" | "deferred" | "resolved"

Related

Incidents Domain Architecture

Incident Reporting User Guide

Reports API

Endpoints for submitting and retrieving shift and manager reports

AI Chat API

Conversational data querying with streaming responses

On this page

OverviewEndpointsReport IncidentAdd CommentUpdate StatusRelated

API Overview