Skip to content

Close an incident

Safety module

POST/incidents/{id}/closeincidents.close

Closes a contained incident with sign-off through app.close_incident; the caller is recorded as the person signing off. The reporter of a critical incident cannot sign off its closure (422). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability safety.incident.close.
  • OAuth scopes: safety.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

incidents.close: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the incident.

Request body: IncidentCloseRequest

incidents.close: IncidentCloseRequest
FieldTypeRequiredDescription
notestringYesSign-off note.Constraints: length 1 to 500
{
  "note": "Area inspected and safe."
}

Response 200: Incident

incidents.close: Incident
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the incident.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
titlestringYesShort description.Constraints: length 1 to 300
occurred_atstring (date-time)YesWhen it happened.
zone_idstring (uuid) | nullYesIdentifier of the zone.
latitudenumber | nullYesWGS 84 latitude.Constraints: range -90 to 90
longitudenumber | nullYesWGS 84 longitude.Constraints: range -180 to 180
severity_enum_idstringYesSeverity: a row of the canon Incident Severity enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
incident_numberintegerYesNumber from the project's display key sequence.Constraints: range 1 to any
incident_state"Reported" | "Dispatched" | "Contained" | "Closed"YesIncident state.
reported_bystring (uuid) | nullYesIdentifier of the reporter, from the session.
closed_signed_off_bystring (uuid) | nullYesIdentifier of the person who signed off the closure.
accuracy_mnumber | nullYesHorizontal accuracy of the location in meters.
device_reported_atstring (date-time) | nullYesWhen the reporter filed it on the device, for a report queued offline.
closed_atstring (date-time) | nullYesWhen the incident moved to Closed, from its transition ledger.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Guest Fall Near North Bar",
  "occurred_at": "2026-10-08T14:30:00Z",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "latitude": 25.7617,
  "longitude": -80.1918,
  "severity_enum_id": "ENM-097",
  "incident_number": 142,
  "incident_state": "Reported",
  "reported_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "closed_signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "accuracy_m": 8,
  "device_reported_at": "2026-10-08T14:30:00Z",
  "closed_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/incidents/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/close" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"note":"Area inspected and safe."}'
const { data } = await xos.incidents.close("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "note": "Area inspected and safe."
  });
response = xos.incidents.close("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"note": "Area inspected and safe."})
xos incidents close 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"note":"Area inspected and safe."}'