Skip to content

Create a crisis alert

Safety module

POST/crisis-alertscrisisAlerts.create

A crisis alert broadcast to a project. Creates a crisis alert. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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

Request body: CrisisAlertCreate

crisisAlerts.create: CrisisAlertCreate
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project.
messagestringYesAlert message.Constraints: length 1 to 300
ended_atstring (date-time) | nullNoWhen the alert was cleared.
emergency_codestringYesCanon emergency code announced.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "Weather hold: clear the north lawn.",
  "ended_at": "2026-10-08T14:30:00Z",
  "emergency_code": "CODE_RED"
}

Response 201: CrisisAlert

crisisAlerts.create: CrisisAlert
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the crisis alert.
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.
messagestringYesAlert message.Constraints: length 1 to 300
issued_atstring (date-time)YesWhen the alert was issued.
ended_atstring (date-time) | nullYesWhen the alert was cleared.
emergency_codestringYesCanon emergency code announced.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "message": "Weather hold: clear the north lawn.",
  "issued_at": "2026-10-08T14:30:00Z",
  "ended_at": "2026-10-08T14:30:00Z",
  "emergency_code": "CODE_RED"
}

Code samples

curl -X POST "$XOS_BASE_URL/crisis-alerts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"Weather hold: clear the north lawn.","ended_at":"2026-10-08T14:30:00Z","emergency_code":"CODE_RED"}'
const { data } = await xos.crisisAlerts.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "message": "Weather hold: clear the north lawn.",
    "ended_at": "2026-10-08T14:30:00Z",
    "emergency_code": "CODE_RED"
  });
response = xos.crisis_alerts.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "message": "Weather hold: clear the north lawn.", "ended_at": "2026-10-08T14:30:00Z", "emergency_code": "CODE_RED"})
xos crisis-alerts create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"Weather hold: clear the north lawn.","ended_at":"2026-10-08T14:30:00Z","emergency_code":"CODE_RED"}'